I also diffed these two files and eliminated cosmetic differences to make it
easier to ensure both are in alignment.
| No Linters Available |
| No Unit Test Coverage |
| Path | Packages | |||
|---|---|---|---|---|
| M | contrib/packaging/inno/readme.rst (41 lines) | |||
| M | contrib/packaging/wix/readme.rst (36 lines) |
| Commit | Parents | Author | Summary | Date |
|---|---|---|---|---|
| db37f04b2c9d | 5fe18761a4cf | Matt Harbison | Apr 18 2022, 4:11 PM |
| Status | Author | Revision | |
|---|---|---|---|
| Closed | mharbison72 | ||
| Closed | mharbison72 | ||
| Closed | mharbison72 |
| Requirements | Requirements | ||||
| ============ | ============ | ||||
| Building the Inno installer requires a Windows machine. | Building the Inno installer requires a Windows machine. | ||||
| The following system dependencies must be installed: | The following system 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) | |||||
| * Inno Setup (http://jrsoftware.org/isdl.php) version 5.4 or newer. | * Inno Setup (http://jrsoftware.org/isdl.php) version 5.4 or newer. | ||||
| Be sure to install the optional Inno Setup Preprocessor feature, | Be sure to install the optional Inno Setup Preprocessor feature, | ||||
| which is required. | which is required. | ||||
| * Python 3.5+ (to run the ``packaging.py`` script) | * Python 3.6+ (to run the ``packaging.py`` script) | ||||
| Building | Building | ||||
| ======== | ======== | ||||
| The ``packaging.py`` script automates the process of producing an | The ``packaging.py`` script automates the process of producing an Inno | ||||
| Inno installer. It manages fetching and configuring the | installer. It manages fetching and configuring non-system dependencies | ||||
| non-system dependencies (such as py2exe, gettext, and various | (such as gettext, and various Python packages). It can be run from a | ||||
| Python packages). | basic cmd.exe Window (i.e. activating the MSBuildTools environment is | ||||
| not required). | |||||
| 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. | From the prompt, change to the Mercurial source directory. e.g. | ||||
| ``cd c:\src\hg``. | ``cd c:\src\hg``. | ||||
| Next, invoke ``packaging.py`` to produce an Inno installer. You will | Next, invoke ``packaging.py`` to produce an Inno installer.:: | ||||
| need to supply the path to the Python interpreter to use.:: | |||||
| $ py -3 contrib\packaging\packaging.py \ | $ py -3 contrib\packaging\packaging.py \ | ||||
| inno --python c:\python27\python.exe | inno --pyoxidizer-target x86_64-pc-windows-msvc | ||||
| .. 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 and errors | |||||
| if not. | |||||
| If everything runs as intended, dependencies will be fetched and | If everything runs as intended, dependencies will be fetched and | ||||
| configured into the ``build`` sub-directory, Mercurial will be built, | configured into the ``build`` sub-directory, Mercurial will be built, | ||||
| and an installer placed in the ``dist`` sub-directory. The final | and an installer placed in the ``dist`` sub-directory. The final line | ||||
| line of output should print the name of the generated installer. | of output should print the name of the generated installer. | ||||
| Additional options may be configured. Run | Additional options may be configured. Run ``packaging.py inno --help`` | ||||
| ``packaging.py inno --help`` to see a list of program flags. | to see a list of program flags. | ||||
| MinGW | MinGW | ||||
| ===== | ===== | ||||
| It is theoretically possible to generate an installer that uses | It is theoretically possible to generate an installer that uses | ||||
| MinGW. This isn't well tested and ``packaging.py`` and may properly | MinGW. This isn't well tested and ``packaging.py`` and may properly | ||||
| support it. See old versions of this file in version control for | support it. See old versions of this file in version control for | ||||
| potentially useful hints as to how to achieve this. | potentially useful hints as to how to achieve this. | ||||
| WiX Installer | WiX Installer | ||||
| ============= | ============= | ||||
| The files in this directory are used to produce an MSI installer using | The files in this directory are used to produce an MSI installer using | ||||
| the WiX Toolset (http://wixtoolset.org/). | the WiX Toolset (http://wixtoolset.org/). | ||||
| The MSI installers require elevated (admin) privileges due to the | The MSI installers require elevated (admin) privileges due to the | ||||
| installation of MSVC CRT libraries into the Windows system store. See | installation of MSVC CRT libraries into the Windows system store. See | ||||
| the Inno Setup installers in the ``inno`` sibling directory for installers | the Inno Setup installers in the ``inno`` sibling directory for installers | ||||
| that do not have this requirement. | that do not have this requirement. | ||||
| Requirements | Requirements | ||||
| ============ | ============ | ||||
| Building the WiX installers requires a Windows machine. The following | Building the WiX installer requires a Windows machine. | ||||
| dependencies must be installed: | |||||
| * Python 2.7 (download from https://www.python.org/downloads/) | The following system dependencies must be installed: | ||||
| * Microsoft Visual C++ Compiler for Python 2.7 | |||||
| (https://www.microsoft.com/en-us/download/details.aspx?id=44266) | * Python 3.6+ (to run the ``packaging.py`` script) | ||||
| * Python 3.5+ (to run the ``packaging.py`` script) | |||||
| Building | Building | ||||
| ======== | ======== | ||||
| The ``packaging.py`` script automates the process of producing an MSI | The ``packaging.py`` script automates the process of producing an MSI | ||||
| installer. It manages fetching and configuring non-system dependencies | installer. It manages fetching and configuring non-system dependencies | ||||
| (such as py2exe, gettext, and various Python packages). | (such as gettext, and various Python packages). It can be run from a | ||||
| basic cmd.exe Window (i.e. activating the MSBuildTools environment is | |||||
| The script requires an activated ``Visual C++ 2008`` command prompt. | not required). | ||||
| 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. | From the prompt, change to the Mercurial source directory. e.g. | ||||
| ``cd c:\src\hg``. | ``cd c:\src\hg``. | ||||
| Next, invoke ``packaging.py`` to produce an MSI installer. You will need | Next, invoke ``packaging.py`` to produce an MSI installer.:: | ||||
| to supply the path to the Python interpreter to use.:: | |||||
| $ py -3 contrib\packaging\packaging.py \ | $ py -3 contrib\packaging\packaging.py \ | ||||
| wix --python c:\python27\python.exe | wix --pyoxidizer-target x86_64-pc-windows-msvc | ||||
| .. 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 | If everything runs as intended, dependencies will be fetched and | ||||
| configured into the ``build`` sub-directory, Mercurial will be built, | configured into the ``build`` sub-directory, Mercurial will be built, | ||||
| and an installer placed in the ``dist`` sub-directory. The final line | and an installer placed in the ``dist`` sub-directory. The final line | ||||
| of output should print the name of the generated installer. | of output should print the name of the generated installer. | ||||
| Additional options may be configured. Run ``packaging.py wix --help`` to | Additional options may be configured. Run ``packaging.py wix --help`` | ||||
| see a list of program flags. | to see a list of program flags. | ||||
| Relationship to TortoiseHG | Relationship to TortoiseHG | ||||
| ========================== | ========================== | ||||
| TortoiseHG uses the WiX files in this directory. | TortoiseHG uses the WiX files in this directory. | ||||
| The code for building TortoiseHG installers lives at | The code for building TortoiseHG installers lives at | ||||
| https://bitbucket.org/tortoisehg/thg-winbuild and is maintained by | https://bitbucket.org/tortoisehg/thg-winbuild and is maintained by | ||||
| Steve Borho (steve@borho.org). | Steve Borho (steve@borho.org). | ||||
| When changing behavior of the WiX installer, be sure to notify | When changing behavior of the WiX installer, be sure to notify | ||||
| the TortoiseHG Project of the changes so they have ample time | the TortoiseHG Project of the changes so they have ample time | ||||
| provide feedback and react to those changes. | provide feedback and react to those changes. | ||||