Mercurial > public > mercurial-scm > hg-stable
diff mercurial/help/config.txt @ 17267:979b107eaea2 stable
doc: unify section level between help topics
Some help topics use "-" for the top level underlining section mark,
but "-" is used also for the top level categorization in generated
documents: "hg.1.html", for example.
So, TOC in such documents contain "sections in each topics", too.
This patch changes underlining section mark in some help topics to
unify section level in generated documents.
After this patching, levels of each section marks are:
level0
""""""
level1
======
level2
------
level3
......
level4
######
And use of section markers in each documents are:
- mercurial/help/*.txt can use level1 or more
(now these use level1 and level2)
- help for core commands can use level2 or more
(now these use no section marker)
- descriptions of extensions can use level2 or more
(now hgext/acl uses level2)
- help for commands defined in extension can use level4 or more
(now "convert" of hgext/convert uses level4)
"Level0" is used as top level categorization only in "doc/hg.1.txt"
and the intermediate file generated by "doc/gendoc.py", so end users
don't see it in "hg help" outoput and so on.
author | FUJIWARA Katsunori <foozy@lares.dti.ne.jp> |
---|---|
date | Wed, 25 Jul 2012 16:40:38 +0900 |
parents | 98166640b356 |
children | 8cf995a6dcb0 |
line wrap: on
line diff
--- a/mercurial/help/config.txt Mon Jul 23 19:03:32 2012 +0200 +++ b/mercurial/help/config.txt Wed Jul 25 16:40:38 2012 +0900 @@ -13,7 +13,7 @@ ``ui.verbose``, respectively. See the Syntax section below. Files ------ +===== Mercurial reads configuration data from several files, if they exist. These files do not exist by default and you will have to create the @@ -86,7 +86,7 @@ order until one or more configuration files are detected. Syntax ------- +====== A configuration file consists of sections, led by a ``[section]`` header and followed by ``name = value`` entries (sometimes called @@ -171,14 +171,14 @@ (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``). Sections --------- +======== This section describes the different sections that may appear in a Mercurial configuration file, the purpose of each section, its possible keys, and their possible values. ``alias`` -""""""""" +--------- Defines command aliases. Aliases allow you to define your own commands in terms of other @@ -238,7 +238,7 @@ ``annotate`` -"""""""""""" +------------ Settings used when displaying file annotations. All values are Booleans and default to False. See ``diff`` section for related @@ -255,7 +255,7 @@ ``auth`` -"""""""" +-------- Authentication credentials for HTTP authentication. This section allows you to store usernames and passwords for use when logging @@ -322,7 +322,7 @@ ``decode/encode`` -""""""""""""""""" +----------------- Filters for transforming files on checkout/checkin. This would typically be used for newline processing or other @@ -369,7 +369,7 @@ ``defaults`` -"""""""""""" +------------ (defaults are deprecated. Don't use them. Use aliases instead) @@ -389,7 +389,7 @@ ``diff`` -"""""""" +-------- Settings used when displaying diffs. Everything except for ``unified`` is a Boolean and defaults to False. See ``annotate`` section for @@ -417,7 +417,7 @@ Number of lines of context to show. ``email`` -""""""""" +--------- Settings for extensions that send email messages. @@ -472,7 +472,7 @@ ``extensions`` -"""""""""""""" +-------------- Mercurial has an extension mechanism for adding new features. To enable an extension, create an entry for it in this section. @@ -499,7 +499,7 @@ ``format`` -"""""""""" +---------- ``usestore`` Enable or disable the "store" repository format which improves @@ -526,7 +526,7 @@ repositories will be compatible with Mercurial before version 1.7. ``graph`` -""""""""" +--------- Web graph view configuration. This section let you change graph elements display properties by branches, for instance to make the @@ -554,7 +554,7 @@ Set branch edges color in hexadecimal RGB notation. ``hooks`` -""""""""" +--------- Commands or Python functions that get automatically executed by various actions such as starting or finishing a commit. Multiple @@ -733,7 +733,7 @@ ``hostfingerprints`` -"""""""""""""""""""" +-------------------- Fingerprints of the certificates of known HTTPS servers. A HTTPS connection to a server with a fingerprint configured here will @@ -751,7 +751,7 @@ ``http_proxy`` -"""""""""""""" +-------------- Used to access web-based Mercurial repositories through a HTTP proxy. @@ -775,7 +775,7 @@ in ``http_proxy.no``. True or False. Default: False. ``merge-patterns`` -"""""""""""""""""" +------------------ This section specifies merge tools to associate with particular file patterns. Tools matched here will take precedence over the default @@ -789,7 +789,7 @@ **.jpg = myimgmerge ``merge-tools`` -""""""""""""""" +--------------- This section configures external merge tools to use for file-level merges. @@ -889,7 +889,7 @@ ``patch`` -""""""""" +--------- Settings used when applying patches, for instance through the 'import' command or with Mercurial Queues extension. @@ -907,7 +907,7 @@ ``paths`` -""""""""" +--------- Assigns symbolic names to repositories. The left side is the symbolic name, and the right gives the directory or URL that is the @@ -924,7 +924,7 @@ is specified. ``phases`` -"""""""""" +---------- Specifies default handling of phases. See :hg:`help phases` for more information about working with phases. @@ -940,7 +940,7 @@ Default: draft ``profiling`` -""""""""""""" +------------- Specifies profiling type, format, and file output. Two profilers are supported: an instrumenting profiler (named ``ls``), and a sampling @@ -988,12 +988,12 @@ stderr ``revsetalias`` -""""""""""""""" +--------------- Alias definitions for revsets. See :hg:`help revsets` for details. ``server`` -"""""""""" +---------- Controls generic server settings. @@ -1019,7 +1019,7 @@ present. Default is False. ``smtp`` -"""""""" +-------- Configuration for extensions that need to send email messages. @@ -1048,7 +1048,7 @@ ``subpaths`` -"""""""""""" +------------ Subrepository source URLs can go stale if a remote server changes name or becomes temporarily unavailable. This section lets you define @@ -1070,7 +1070,7 @@ are applied in definition order. ``trusted`` -""""""""""" +----------- Mercurial will not use the settings in the ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted @@ -1094,7 +1094,7 @@ ``ui`` -"""""" +------ User interface controls. @@ -1213,7 +1213,7 @@ ``web`` -""""""" +------- Web interface configuration. The settings in this section apply to both the builtin webserver (started by :hg:`serve`) and the script you