Mercurial > hg
comparison doc/hg.1.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 | 170fc0949fb6 |
comparison
equal
deleted
inserted
replaced
| 17266:4e35dea77e31 | 17267:979b107eaea2 |
|---|---|
| 16 :class: htmlonly | 16 :class: htmlonly |
| 17 :depth: 1 | 17 :depth: 1 |
| 18 | 18 |
| 19 | 19 |
| 20 Synopsis | 20 Synopsis |
| 21 -------- | 21 """""""" |
| 22 **hg** *command* [*option*]... [*argument*]... | 22 **hg** *command* [*option*]... [*argument*]... |
| 23 | 23 |
| 24 Description | 24 Description |
| 25 ----------- | 25 """"""""""" |
| 26 The **hg** command provides a command line interface to the Mercurial | 26 The **hg** command provides a command line interface to the Mercurial |
| 27 system. | 27 system. |
| 28 | 28 |
| 29 Command Elements | 29 Command Elements |
| 30 ---------------- | 30 """""""""""""""" |
| 31 | 31 |
| 32 files... | 32 files... |
| 33 indicates one or more filename or relative path filenames; see | 33 indicates one or more filename or relative path filenames; see |
| 34 `File Name Patterns`_ for information on pattern matching | 34 `File Name Patterns`_ for information on pattern matching |
| 35 | 35 |
| 46 repository. | 46 repository. |
| 47 | 47 |
| 48 .. include:: hg.1.gendoc.txt | 48 .. include:: hg.1.gendoc.txt |
| 49 | 49 |
| 50 Files | 50 Files |
| 51 ----- | 51 """"" |
| 52 | 52 |
| 53 ``/etc/mercurial/hgrc``, ``$HOME/.hgrc``, ``.hg/hgrc`` | 53 ``/etc/mercurial/hgrc``, ``$HOME/.hgrc``, ``.hg/hgrc`` |
| 54 This file contains defaults and configuration. Values in | 54 This file contains defaults and configuration. Values in |
| 55 ``.hg/hgrc`` override those in ``$HOME/.hgrc``, and these override | 55 ``.hg/hgrc`` override those in ``$HOME/.hgrc``, and these override |
| 56 settings made in the global ``/etc/mercurial/hgrc`` configuration. | 56 settings made in the global ``/etc/mercurial/hgrc`` configuration. |
| 88 Some commands (e.g. revert) produce backup files ending in ``.orig``, | 88 Some commands (e.g. revert) produce backup files ending in ``.orig``, |
| 89 if the ``.orig`` file already exists and is not tracked by Mercurial, | 89 if the ``.orig`` file already exists and is not tracked by Mercurial, |
| 90 it will be overwritten. | 90 it will be overwritten. |
| 91 | 91 |
| 92 Bugs | 92 Bugs |
| 93 ---- | 93 """" |
| 94 Probably lots, please post them to the mailing list (see Resources_ | 94 Probably lots, please post them to the mailing list (see Resources_ |
| 95 below) when you find them. | 95 below) when you find them. |
| 96 | 96 |
| 97 See Also | 97 See Also |
| 98 -------- | 98 """""""" |
| 99 |hgignore(5)|_, |hgrc(5)|_ | 99 |hgignore(5)|_, |hgrc(5)|_ |
| 100 | 100 |
| 101 Author | 101 Author |
| 102 ------ | 102 """""" |
| 103 Written by Matt Mackall <mpm@selenic.com> | 103 Written by Matt Mackall <mpm@selenic.com> |
| 104 | 104 |
| 105 Resources | 105 Resources |
| 106 --------- | 106 """"""""" |
| 107 Main Web Site: http://mercurial.selenic.com/ | 107 Main Web Site: http://mercurial.selenic.com/ |
| 108 | 108 |
| 109 Source code repository: http://selenic.com/hg | 109 Source code repository: http://selenic.com/hg |
| 110 | 110 |
| 111 Mailing list: http://selenic.com/mailman/listinfo/mercurial | 111 Mailing list: http://selenic.com/mailman/listinfo/mercurial |
| 112 | 112 |
| 113 Copying | 113 Copying |
| 114 ------- | 114 """"""" |
| 115 Copyright (C) 2005-2012 Matt Mackall. | 115 Copyright (C) 2005-2012 Matt Mackall. |
| 116 Free use of this software is granted under the terms of the GNU General | 116 Free use of this software is granted under the terms of the GNU General |
| 117 Public License version 2 or any later version. | 117 Public License version 2 or any later version. |
| 118 | 118 |
| 119 .. include:: common.txt | 119 .. include:: common.txt |