sapling/mercurial/help
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
..
internals help: fix layout of pre-formatted text 2017-03-09 12:55:48 +09:00
bundlespec.txt help: document bundle specifications 2017-04-01 13:42:06 -07:00
color.txt color: update main documentation 2017-02-21 20:04:55 +01:00
common.txt doc: make man and html from translated documents 2013-07-03 21:49:43 +09:00
config.txt hook: add hook name information to external hook 2017-03-31 11:53:56 +02:00
dates.txt doc: fix internal date sample (issue4072) 2013-10-29 21:54:49 +02:00
diffs.txt help: refer to user configuration file more consistently 2010-08-27 22:36:35 -04:00
environment.txt ui: drop template aliases by HGPLAIN 2016-03-27 21:05:55 +09:00
extensions.txt doc: make it easier to read how to enable extensions 2013-06-06 14:05:03 -04:00
filesets.txt help: fix example of revs() fileset 2017-03-09 11:01:03 +09:00
glossary.txt glossary: fixup use of periods at end of entries 2015-08-28 12:18:12 -04:00
hg-ssh.8.txt help: replace selenic.com by mercurial-scm.org in man pages 2016-11-01 20:39:36 +09:00
hg.1.txt misc: update year in copyright lines 2017-02-12 02:23:33 +09:00
hgignore.5.txt misc: update year in copyright lines 2017-02-12 02:23:33 +09:00
hgignore.txt help: add documentation on include: and subinclude: 2015-05-20 14:54:09 -07:00
hgrc.5.txt misc: update year in copyright lines 2017-02-12 02:23:33 +09:00
hgweb.txt spelling: trivial spell checking 2015-10-17 00:58:46 +02:00
merge-tools.txt filemerge: switch the default name for internal tools from internal:x to :x 2014-09-28 17:15:28 +02:00
pager.txt pager: add a config knob to just globally turn off the pager 2017-02-07 17:13:25 -05:00
patterns.txt match: adding support for matching files inside a directory 2017-02-13 15:39:29 -08:00
phases.txt phases: mention how to make secret commits in help 2015-12-22 20:10:22 +00:00
revisions.txt help: eliminate duplicate text for revset string patterns 2017-01-07 23:35:35 -05:00
scripting.txt help: update link to wiki/CommandServer 2016-08-04 10:42:03 +08:00
subrepos.txt files: recurse into subrepos automatically with an explicit path 2015-05-17 22:42:47 -04:00
templates.txt help: merge the various operator sections of revsets, filesets and templates 2017-01-08 12:05:10 -05:00
urls.txt help: stop documentation markup appearing in generated help 2013-05-15 22:19:12 +01:00