Mercurial > hg
comparison mercurial/help/phases.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 | 3d26d69ef822 |
children | 170fc0949fb6 |
comparison
equal
deleted
inserted
replaced
17266:4e35dea77e31 | 17267:979b107eaea2 |
---|---|
1 What are phases? | 1 What are phases? |
2 ---------------- | 2 ================ |
3 | 3 |
4 Phases are a system for tracking which changesets have been or should | 4 Phases are a system for tracking which changesets have been or should |
5 be shared. This helps prevent common mistakes when modifying history | 5 be shared. This helps prevent common mistakes when modifying history |
6 (for instance, with the mq or rebase extensions). | 6 (for instance, with the mq or rebase extensions). |
7 | 7 |
15 can be in a lower phase than its ancestors. For instance, if a | 15 can be in a lower phase than its ancestors. For instance, if a |
16 changeset is public, all its ancestors are also public. Lastly, | 16 changeset is public, all its ancestors are also public. Lastly, |
17 changeset phases should only be changed towards the public phase. | 17 changeset phases should only be changed towards the public phase. |
18 | 18 |
19 How are phases managed? | 19 How are phases managed? |
20 ----------------------- | 20 ======================= |
21 | 21 |
22 For the most part, phases should work transparently. By default, a | 22 For the most part, phases should work transparently. By default, a |
23 changeset is created in the draft phase and is moved into the public | 23 changeset is created in the draft phase and is moved into the public |
24 phase when it is pushed to another repository. | 24 phase when it is pushed to another repository. |
25 | 25 |
27 refuse to operate on them to prevent creating duplicate changesets. | 27 refuse to operate on them to prevent creating duplicate changesets. |
28 Phases can also be manually manipulated with the :hg:`phase` command | 28 Phases can also be manually manipulated with the :hg:`phase` command |
29 if needed. See :hg:`help -v phase` for examples. | 29 if needed. See :hg:`help -v phase` for examples. |
30 | 30 |
31 Phases and servers | 31 Phases and servers |
32 ------------------ | 32 ================== |
33 | 33 |
34 Normally, all servers are ``publishing`` by default. This means:: | 34 Normally, all servers are ``publishing`` by default. This means:: |
35 | 35 |
36 - all draft changesets that are pulled or cloned appear in phase | 36 - all draft changesets that are pulled or cloned appear in phase |
37 public on the client | 37 public on the client |
57 .. note:: | 57 .. note:: |
58 Servers running older versions of Mercurial are treated as | 58 Servers running older versions of Mercurial are treated as |
59 publishing. | 59 publishing. |
60 | 60 |
61 Examples | 61 Examples |
62 -------- | 62 ======== |
63 | 63 |
64 - list changesets in draft or secret phase:: | 64 - list changesets in draft or secret phase:: |
65 | 65 |
66 hg log -r "not public()" | 66 hg log -r "not public()" |
67 | 67 |