upstream/mercurial-mirror Files · contrib/wix/help.wxs

help: document bundle specifications...

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 76104a4899ad. 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.

Gregory Szorc - - Load All Authors

File last commit:

r31793:69d8fcf2 default


                r31793:69d8fcf2

default

Download file

             help.wxs
        
                    55 lines
            
             | 2.0 KiB
            
                | text/plain
            
             |
                TextLexer

/ contrib / wix / help.wxs

History | Source | Raw |Copy content |Copy permalink

Adrian Buehlmann wix: refactor and new guids.wxi	r10828	<?xml version="1.0" encoding="utf-8"?>
Adrian Buehlmann contrib/wix: switch *.wxs files to LF eol	r10513	<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
Adrian Buehlmann wix: refactor and new guids.wxi	r10828
		<?include guids.wxi ?>
Steve Borho wix: add support for x64 native MSI packages	r13042	<?include defines.wxi ?>
Adrian Buehlmann wix: refactor and new guids.wxi	r10828
		<Fragment>
Matt Harbison wix: add help for current internal topics...	r27684	<ComponentGroup Id='helpFolder'>
		<ComponentRef Id='help.root' />
		<ComponentRef Id='help.internals' />
		</ComponentGroup>
		</Fragment>

		<Fragment>
Adrian Buehlmann wix: refactor and new guids.wxi	r10828	<DirectoryRef Id="INSTALLDIR">
		<Directory Id="helpdir" Name="help" FileSource="$(var.SourceDir)">
Matt Harbison wix: add help for current internal topics...	r27684	<Component Id="help.root" Guid="$(var.help.root.guid)" Win64='$(var.IsX64)'>
Gregory Szorc help: document bundle specifications...	r31793	<File Name="bundlespec.txt" />
Pierre-Yves David color: update main documentation...	r31123	<File Name="color.txt" />
Adrian Buehlmann wix: refactor and new guids.wxi	r10828	<File Name="config.txt" KeyPath="yes" />
		<File Name="dates.txt" />
		<File Name="diffs.txt" />
		<File Name="environment.txt" />
		<File Name="extensions.txt" />
Steve Borho wix: catch up with more added files...	r14819	<File Name="filesets.txt" />
Steve Borho wix: pick up new help topics added between 1.5 and 1.6...	r11491	<File Name="glossary.txt" />
Steve Borho wix: catch up with more added files...	r14819	<File Name="hgignore.txt" />
Steve Borho wix: pick up new help topics added between 1.5 and 1.6...	r11491	<File Name="hgweb.txt" />
Steve Borho wix: add new merge-tools.txt help text	r12790	<File Name="merge-tools.txt" />
Matt Harbison wix: include the help for pager...	r31098	<File Name="pager.txt" />
Adrian Buehlmann wix: refactor and new guids.wxi	r10828	<File Name="patterns.txt" />
Steve Borho wix: add phases help text and two more translations (issue 3288)	r16220	<File Name="phases.txt" />
Adrian Buehlmann wix: refactor and new guids.wxi	r10828	<File Name="revisions.txt" />
Matt Harbison wix: avoid an abort with 'hg help -k foo'...	r26119	<File Name="scripting.txt" />
Steve Borho wix: add subrepos help text	r12830	<File Name="subrepos.txt" />
Adrian Buehlmann wix: refactor and new guids.wxi	r10828	<File Name="templates.txt" />
		<File Name="urls.txt" />
		</Component>
Matt Harbison wix: add help for current internal topics...	r27684
		<Directory Id="help.internaldir" Name="internals">
		<Component Id="help.internals" Guid="$(var.help.internals.guid)" Win64='$(var.IsX64)'>
		<File Id="internals.bundles.txt" Name="bundles.txt" KeyPath="yes" />
Augie Fackler wix: add censor docs to installer script...	r31281	<File Id="internals.censor.txt" Name="censor.txt" KeyPath="yes" />
Matt Harbison wix: add help for current internal topics...	r27684	<File Id="internals.changegroups.txt" Name="changegroups.txt" />
Gregory Szorc help: document requirements...	r28523	<File Id="internals.requirements.txt" Name="requirements.txt" />
Matt Harbison wix: add help for current internal topics...	r27684	<File Id="internals.revlogs.txt" Name="revlogs.txt" />
Gregory Szorc help: internals topic for wire protocol...	r29859	<File Id="internals.wireprotocol.txt" Name="wireprotocol.txt" />
Matt Harbison wix: add help for current internal topics...	r27684	</Component>
		</Directory>

Adrian Buehlmann wix: refactor and new guids.wxi	r10828	</Directory>
		</DirectoryRef>
		</Fragment>

Adrian Buehlmann contrib/wix: switch *.wxs files to LF eol	r10513	</Wix>

	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