Mercurial > hg
diff tests/test-convert.t @ 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 | 4f8054d3171b |
line wrap: on
line diff
--- a/tests/test-convert.t Mon Jul 23 19:03:32 2012 +0200 +++ b/tests/test-convert.t Wed Jul 25 16:40:38 2012 +0900 @@ -120,7 +120,7 @@ to a named branch. Mercurial Source - '''''''''''''''' + ################ The Mercurial source recognizes the following configuration options, which you can set on the command line with "--config": @@ -138,7 +138,7 @@ revision identifier and defaults to 0. CVS Source - '''''''''' + ########## CVS source will use a sandbox (i.e. a checked-out copy) from CVS to indicate the starting point of what will be converted. Direct access to @@ -188,7 +188,7 @@ more details. Subversion Source - ''''''''''''''''' + ################# Subversion source detects classical trunk/branches/tags layouts. By default, the supplied "svn://repo/path/" source URL is converted as a @@ -220,7 +220,7 @@ specify start Subversion revision number. The default is 0. Perforce Source - ''''''''''''''' + ############### The Perforce (P4) importer can be given a p4 depot path or a client specification as source. It will convert all files in the source to a flat @@ -236,7 +236,7 @@ number). Mercurial Destination - ''''''''''''''''''''' + ##################### The following options are supported: