##// END OF EJS Templates
upstream » mercurial-mirror
RSS

Clone from https://www.mercurial-scm.org/repo/hg-all

configitems: declare items in a TOML file...
configitems: declare items in a TOML file Mercurial ships with Rust code that also needs to read from the config. Having a way of presenting `configitems` to both Python and Rust is needed to prevent duplication, drift, and have the appropriate devel warnings. Abstracting away from Python means choosing a config format. No single format is perfect, and I have yet to come across a developer that doesn't hate all of them in some way. Since we have a strict no-dependencies policy for Mercurial, we either need to use whatever comes with Python, vendor a library, or implement a custom format ourselves. Python stdlib means using JSON, which doesn't support comments and isn't great for humans, or `configparser` which is an obscure, untyped format that nobody uses and doesn't have a commonplace Rust parser. Implementing a custom format is error-prone, tedious and subject to the same issues as picking an existing format. Vendoring opens us to the vast array of common config formats. The ones being picked for most modern software are YAML and TOML. YAML is older and common in the Python community, but TOML is much simpler and less error-prone. I would much rather be responsible for the <1000 lines of `tomli`, on top of TOML being the choice of the Rust community, with robust crates for reading it. The structure of `configitems.toml` is explained inline.
Raphaël Gomès -
r51655:c51b178b default
Show More
Name Size Modified Last Commit Author
/ contrib / packaging / wix
COPYING.rtf Loading ...
defines.wxi Loading ...
guids.wxi Loading ...
mercurial.wxs Loading ...
readme.rst Loading ...

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 installer requires a Windows machine.

The following system dependencies must be installed:

  • Python 3.6+ (to run the packaging.py script)

Building

The packaging.py script automates the process of producing an MSI installer. It manages fetching and configuring non-system dependencies (such as gettext, and various Python packages). It can be run from a basic cmd.exe Window (i.e. activating the MSBuildTools environment is not required).

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

Next, invoke packaging.py to produce an MSI installer.:

$ py -3 contrib\packaging\packaging.py \
    wix --pyoxidizer-target x86_64-pc-windows-msvc

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 packaging.py wix --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://foss.heptapod.net/mercurial/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.