comparison doc/hgrc.5.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 e49e039acd5e
children 6f3428c528b4
comparison
equal deleted inserted replaced
17266:4e35dea77e31 17267:979b107eaea2
15 :backlinks: top 15 :backlinks: top
16 :class: htmlonly 16 :class: htmlonly
17 17
18 18
19 Synopsis 19 Synopsis
20 -------- 20 ========
21 21
22 .. include:: ../mercurial/help/config.txt 22 .. include:: ../mercurial/help/config.txt
23 23
24 Author 24 Author
25 ------ 25 ======
26 Bryan O'Sullivan <bos@serpentine.com>. 26 Bryan O'Sullivan <bos@serpentine.com>.
27 27
28 Mercurial was written by Matt Mackall <mpm@selenic.com>. 28 Mercurial was written by Matt Mackall <mpm@selenic.com>.
29 29
30 See Also 30 See Also
31 -------- 31 ========
32 |hg(1)|_, |hgignore(5)|_ 32 |hg(1)|_, |hgignore(5)|_
33 33
34 Copying 34 Copying
35 ------- 35 =======
36 This manual page is copyright 2005 Bryan O'Sullivan. 36 This manual page is copyright 2005 Bryan O'Sullivan.
37 Mercurial is copyright 2005-2012 Matt Mackall. 37 Mercurial is copyright 2005-2012 Matt Mackall.
38 Free use of this software is granted under the terms of the GNU General 38 Free use of this software is granted under the terms of the GNU General
39 Public License version 2 or any later version. 39 Public License version 2 or any later version.
40 40