sapling/contrib/wix
Gregory Szorc 2f6dff3311 help: document bundle specifications
I softly formalized the concept of a "bundle specification" a while
ago when I was working on clone bundles and stream clone bundles and
wanted a more robust way to define what exactly is in a bundle file.

The concept has existed for a while. Since it is part of the clone
bundles feature and exposed to the user via the "-t" argument to
`hg bundle`, it is something we need to support for the long haul.

After the 4.1 release, I heard a few people comment that they didn't
realize you could generate zstd bundles with `hg bundle`. I'm
partially to blame for not documenting it in bundle's docstring.

Additionally, I added a hacky, experimental feature for controlling
the compression level of bundles in 054e64c4d837. As the commit
message says, I went with a quick and dirty solution out of time
constraints. Furthermore, I wanted to eventually store this
configuration in the "bundlespec" so it could be made more flexible.

Given:

a) bundlespecs are here to stay
b) we don't have great documentation over what they are, despite being
   a user-facing feature
c) the list of available compression engines and their behavior isn't
   exposed
d) we need an extensible place to modify behavior of compression
   engines

I want to move forward with formalizing bundlespecs as a user-facing
feature. This commit does that by introducing a "bundlespec" help
page. Leaning on the just-added compression engine documentation
and API, the topic also conveniently lists available compression
engines and details about them. This makes features like zstd
bundle compression more discoverable. e.g. you can now
`hg help -k zstd` and it lists the "bundlespec" topic.
2017-04-01 13:42:06 -07:00
..
contrib.wxs wix: contrib/sample.hgrc is no more 2014-09-15 09:36:12 -05:00
COPYING.rtf copyright: update to 2016 2016-01-21 21:15:52 +00:00
defines.wxi wix: add support for x64 native MSI packages 2010-11-26 17:40:13 -06:00
dist.wxs wix: move library.zip and all *.pyd into a lib/ folder 2015-06-03 14:31:19 -05:00
doc.wxs wix: add support for x64 native MSI packages 2010-11-26 17:40:13 -06:00
guids.wxi wix: add help for current internal topics 2015-12-17 21:24:08 -05:00
help.wxs help: document bundle specifications 2017-04-01 13:42:06 -07:00
hg.cmd wix: switch Mercurial Windows installer to use py2exe --bundle 3 2010-11-26 16:18:19 -06:00
i18n.wxs codingstyle: remove trailing spaces in various text files 2013-04-17 03:40:18 +02:00
locale.wxs wix: add support for x64 native MSI packages 2010-11-26 17:40:13 -06:00
mercurial.wxs misc: replace domain of mercurial ML address by mercurial-scm.org 2017-02-11 00:23:53 +09:00
README.txt help: fix some instances of 'the the' 2012-07-26 02:54:13 +02:00
templates.wxs hgweb: rename linerangelog.js as followlines.js 2017-04-03 10:02:55 +02:00

WiX installer source files
==========================

The files in this folder are used by the thg-winbuild [1] package
building architecture to create a Mercurial MSI installer.   These files
are versioned within the Mercurial source tree because the WXS files
must kept up to date with distribution changes within their branch.  In
other words, the default branch WXS files are expected to diverge from
the stable branch WXS files.  Storing them within the same repository is
the only sane way to keep the source tree and the installer in sync.

The MSI installer builder uses only the mercurial.ini file from the
contrib/win32 folder, the contents of which have been historically used
to create an InnoSetup based installer.  The rest of the files there are
ignored.

The MSI packages built by thg-winbuild require elevated (admin)
privileges to be installed due to the installation of MSVC CRT libraries
under the C:\WINDOWS\WinSxS folder.  Thus the InnoSetup installers may
still be useful to some users.

To build your own MSI packages, clone the thg-winbuild [1] repository
and follow the README.txt [2] instructions closely.  There are fewer
prerequisites for a WiX [3] installer than an InnoSetup installer, but
they are more specific.

Direct questions or comments to Steve Borho <steve@borho.org>

[1] http://bitbucket.org/tortoisehg/thg-winbuild
[2] http://bitbucket.org/tortoisehg/thg-winbuild/src/tip/README.txt
[3] http://wix.sourceforge.net/