upstream/mercurial-mirror Files · contrib/packaging/wix/readme.rst

releasenotes: add a file in which to record release notes...

releasenotes: add a file in which to record release notes I've just spent a few very boring hours going through the changelog for the 5.0 release (829 commits). We only had 5 commits that used the syntax that the release notes extension expects. This commit adds a file in which we can record important changes. The file should preferably be edited in the patch that makes the important change, but it can also be edited after (I think this is an important benefit compared to the release notes extension). I'm thinking that we can rename the file from "next" to "5.1" or something when it's time, and then we'd create a new "next" file on the default branch. I've used the syntax that we use on the our wiki in the template, but I don't care much that we use any valid syntax at all. The idea is mostly to record important changes when they happen. I expect that some copy editing will be needed at release time anyway. Differential Revision: https://phab.mercurial-scm.org/D6332

Gregory Szorc - - Load All Authors

File last commit:

r42087:4371f543 default


                r42457:0ed293a3

default

Download file

             readme.rst
        
                    71 lines
            
             | 2.6 KiB
            
                | text/x-rst
            
             |
                RstLexer
            
             / contrib / packaging / wix / readme.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Gregory Szorc
    
wix: functionality to automate building WiX installers...

              r42087
            
      WiX Installer

      =============

      The files in this directory are used to produce an MSI installer using

      the WiX Toolset (http://wixtoolset.org/).

      The MSI installers require elevated (admin) privileges due to the

      installation of MSVC CRT libraries into the Windows system store. See

      the Inno Setup installers in the ``inno`` sibling directory for installers

      that do not have this requirement.

      Requirements

      ============

      Building the WiX installers requires a Windows machine. The following

      dependencies must be installed:

      * Python 2.7 (download from https://www.python.org/downloads/)

      * Microsoft Visual C++ Compiler for Python 2.7

        (https://www.microsoft.com/en-us/download/details.aspx?id=44266)

      * Python 3.5+ (to run the ``build.py`` script)

      Building

      ========

      The ``build.py`` script automates the process of producing an MSI

      installer. It manages fetching and configuring non-system dependencies

      (such as py2exe, gettext, and various Python packages).

      The script requires an activated ``Visual C++ 2008`` command prompt.

      A shortcut to such a prompt was installed with ``Microsoft Visual

      C++ Compiler for Python 2.7``. From your Start Menu, look for

      ``Microsoft Visual C++ Compiler Package for Python 2.7`` then

      launch either ``Visual C++ 2008 32-bit Command Prompt`` or

      ``Visual C++ 2008 64-bit Command Prompt``.

      From the prompt, change to the Mercurial source directory. e.g.

      ``cd c:\src\hg``.

      Next, invoke ``build.py`` to produce an MSI installer. You will need

      to supply the path to the Python interpreter to use.::

         $ python3 contrib\packaging\wix\build.py \

            --python c:\python27\python.exe

      .. note::

         The script validates that the Visual C++ environment is active and

         that the architecture of the specified Python interpreter matches the

         Visual C++ environment. An error is raised otherwise.

      If everything runs as intended, dependencies will be fetched and

      configured into the ``build`` sub-directory, Mercurial will be built,

      and an installer placed in the ``dist`` sub-directory. The final line

      of output should print the name of the generated installer.

      Additional options may be configured. Run ``build.py --help`` to see

      a list of program flags.

      Relationship to TortoiseHG

      ==========================

      TortoiseHG uses the WiX files in this directory.

      The code for building TortoiseHG installers lives at

      https://bitbucket.org/tortoisehg/thg-winbuild and is maintained by

      Steve Borho (steve@borho.org).

      When changing behavior of the WiX installer, be sure to notify

      the TortoiseHG Project of the changes so they have ample time

      provide feedback and react to those changes.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Gregory Szorc wix: functionality to automate building WiX installers...	r42087	WiX Installer
		=============

		The files in this directory are used to produce an MSI installer using
		the WiX Toolset (http://wixtoolset.org/).

		The MSI installers require elevated (admin) privileges due to the
		installation of MSVC CRT libraries into the Windows system store. See
		the Inno Setup installers in the ``inno`` sibling directory for installers
		that do not have this requirement.

		Requirements
		============

		Building the WiX installers requires a Windows machine. The following
		dependencies must be installed:

		* Python 2.7 (download from https://www.python.org/downloads/)
		* Microsoft Visual C++ Compiler for Python 2.7
		(https://www.microsoft.com/en-us/download/details.aspx?id=44266)
		* Python 3.5+ (to run the ``build.py`` script)

		Building
		========

		The ``build.py`` script automates the process of producing an MSI
		installer. It manages fetching and configuring non-system dependencies
		(such as py2exe, gettext, and various Python packages).

		The script requires an activated ``Visual C++ 2008`` command prompt.
		A shortcut to such a prompt was installed with ``Microsoft Visual
		C++ Compiler for Python 2.7``. From your Start Menu, look for
		``Microsoft Visual C++ Compiler Package for Python 2.7`` then
		launch either ``Visual C++ 2008 32-bit Command Prompt`` or
		``Visual C++ 2008 64-bit Command Prompt``.

		From the prompt, change to the Mercurial source directory. e.g.
		``cd c:\src\hg``.

		Next, invoke ``build.py`` to produce an MSI installer. You will need
		to supply the path to the Python interpreter to use.::

		$ python3 contrib\packaging\wix\build.py \
		--python c:\python27\python.exe

		.. note::

		The script validates that the Visual C++ environment is active and
		that the architecture of the specified Python interpreter matches the
		Visual C++ environment. An error is raised otherwise.

		If everything runs as intended, dependencies will be fetched and
		configured into the ``build`` sub-directory, Mercurial will be built,
		and an installer placed in the ``dist`` sub-directory. The final line
		of output should print the name of the generated installer.

		Additional options may be configured. Run ``build.py --help`` to see
		a list of program flags.

		Relationship to TortoiseHG
		==========================

		TortoiseHG uses the WiX files in this directory.

		The code for building TortoiseHG installers lives at
		https://bitbucket.org/tortoisehg/thg-winbuild and is maintained by
		Steve Borho (steve@borho.org).

		When changing behavior of the WiX installer, be sure to notify
		the TortoiseHG Project of the changes so they have ample time
		provide feedback and react to those changes.