Mercurial > hg
comparison hgext/convert/__init__.py @ 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 | e7cfe3587ea4 |
comparison
equal
deleted
inserted
replaced
17266:4e35dea77e31 | 17267:979b107eaea2 |
---|---|
136 is the destination repository. No whitespace is allowed in the | 136 is the destination repository. No whitespace is allowed in the |
137 branch names. This can be used to (for instance) move code in one | 137 branch names. This can be used to (for instance) move code in one |
138 repository from "default" to a named branch. | 138 repository from "default" to a named branch. |
139 | 139 |
140 Mercurial Source | 140 Mercurial Source |
141 '''''''''''''''' | 141 ################ |
142 | 142 |
143 The Mercurial source recognizes the following configuration | 143 The Mercurial source recognizes the following configuration |
144 options, which you can set on the command line with ``--config``: | 144 options, which you can set on the command line with ``--config``: |
145 | 145 |
146 :convert.hg.ignoreerrors: ignore integrity errors when reading. | 146 :convert.hg.ignoreerrors: ignore integrity errors when reading. |
153 | 153 |
154 :convert.hg.startrev: convert start revision and its descendants. | 154 :convert.hg.startrev: convert start revision and its descendants. |
155 It takes a hg revision identifier and defaults to 0. | 155 It takes a hg revision identifier and defaults to 0. |
156 | 156 |
157 CVS Source | 157 CVS Source |
158 '''''''''' | 158 ########## |
159 | 159 |
160 CVS source will use a sandbox (i.e. a checked-out copy) from CVS | 160 CVS source will use a sandbox (i.e. a checked-out copy) from CVS |
161 to indicate the starting point of what will be converted. Direct | 161 to indicate the starting point of what will be converted. Direct |
162 access to the repository files is not needed, unless of course the | 162 access to the repository files is not needed, unless of course the |
163 repository is ``:local:``. The conversion uses the top level | 163 repository is ``:local:``. The conversion uses the top level |
205 changeset merging code to be run without doing a conversion. Its | 205 changeset merging code to be run without doing a conversion. Its |
206 parameters and output are similar to that of cvsps 2.1. Please see | 206 parameters and output are similar to that of cvsps 2.1. Please see |
207 the command help for more details. | 207 the command help for more details. |
208 | 208 |
209 Subversion Source | 209 Subversion Source |
210 ''''''''''''''''' | 210 ################# |
211 | 211 |
212 Subversion source detects classical trunk/branches/tags layouts. | 212 Subversion source detects classical trunk/branches/tags layouts. |
213 By default, the supplied ``svn://repo/path/`` source URL is | 213 By default, the supplied ``svn://repo/path/`` source URL is |
214 converted as a single branch. If ``svn://repo/path/trunk`` exists | 214 converted as a single branch. If ``svn://repo/path/trunk`` exists |
215 it replaces the default branch. If ``svn://repo/path/branches`` | 215 it replaces the default branch. If ``svn://repo/path/branches`` |
237 | 237 |
238 :convert.svn.startrev: specify start Subversion revision number. | 238 :convert.svn.startrev: specify start Subversion revision number. |
239 The default is 0. | 239 The default is 0. |
240 | 240 |
241 Perforce Source | 241 Perforce Source |
242 ''''''''''''''' | 242 ############### |
243 | 243 |
244 The Perforce (P4) importer can be given a p4 depot path or a | 244 The Perforce (P4) importer can be given a p4 depot path or a |
245 client specification as source. It will convert all files in the | 245 client specification as source. It will convert all files in the |
246 source to a flat Mercurial repository, ignoring labels, branches | 246 source to a flat Mercurial repository, ignoring labels, branches |
247 and integrations. Note that when a depot path is given you then | 247 and integrations. Note that when a depot path is given you then |
253 | 253 |
254 :convert.p4.startrev: specify initial Perforce revision (a | 254 :convert.p4.startrev: specify initial Perforce revision (a |
255 Perforce changelist number). | 255 Perforce changelist number). |
256 | 256 |
257 Mercurial Destination | 257 Mercurial Destination |
258 ''''''''''''''''''''' | 258 ##################### |
259 | 259 |
260 The following options are supported: | 260 The following options are supported: |
261 | 261 |
262 :convert.hg.clonebranches: dispatch source branches in separate | 262 :convert.hg.clonebranches: dispatch source branches in separate |
263 clones. The default is False. | 263 clones. The default is False. |