Mercurial > hg
comparison mercurial/help/subrepos.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 | c27a769d9703 |
| children | f5e86b416e05 |
comparison
equal
deleted
inserted
replaced
| 17266:4e35dea77e31 | 17267:979b107eaea2 |
|---|---|
| 41 .. note:: | 41 .. note:: |
| 42 The ``.hgsubstate`` file should not be edited manually. | 42 The ``.hgsubstate`` file should not be edited manually. |
| 43 | 43 |
| 44 | 44 |
| 45 Adding a Subrepository | 45 Adding a Subrepository |
| 46 ---------------------- | 46 ====================== |
| 47 | 47 |
| 48 If ``.hgsub`` does not exist, create it and add it to the parent | 48 If ``.hgsub`` does not exist, create it and add it to the parent |
| 49 repository. Clone or checkout the external projects where you want it | 49 repository. Clone or checkout the external projects where you want it |
| 50 to live in the parent repository. Edit ``.hgsub`` and add the | 50 to live in the parent repository. Edit ``.hgsub`` and add the |
| 51 subrepository entry as described above. At this point, the | 51 subrepository entry as described above. At this point, the |
| 52 subrepository is tracked and the next commit will record its state in | 52 subrepository is tracked and the next commit will record its state in |
| 53 ``.hgsubstate`` and bind it to the committed changeset. | 53 ``.hgsubstate`` and bind it to the committed changeset. |
| 54 | 54 |
| 55 Synchronizing a Subrepository | 55 Synchronizing a Subrepository |
| 56 ----------------------------- | 56 ============================= |
| 57 | 57 |
| 58 Subrepos do not automatically track the latest changeset of their | 58 Subrepos do not automatically track the latest changeset of their |
| 59 sources. Instead, they are updated to the changeset that corresponds | 59 sources. Instead, they are updated to the changeset that corresponds |
| 60 with the changeset checked out in the top-level changeset. This is so | 60 with the changeset checked out in the top-level changeset. This is so |
| 61 developers always get a consistent set of compatible code and | 61 developers always get a consistent set of compatible code and |
| 64 Thus, updating subrepos is a manual process. Simply check out target | 64 Thus, updating subrepos is a manual process. Simply check out target |
| 65 subrepo at the desired revision, test in the top-level repo, then | 65 subrepo at the desired revision, test in the top-level repo, then |
| 66 commit in the parent repository to record the new combination. | 66 commit in the parent repository to record the new combination. |
| 67 | 67 |
| 68 Deleting a Subrepository | 68 Deleting a Subrepository |
| 69 ------------------------ | 69 ======================== |
| 70 | 70 |
| 71 To remove a subrepository from the parent repository, delete its | 71 To remove a subrepository from the parent repository, delete its |
| 72 reference from ``.hgsub``, then remove its files. | 72 reference from ``.hgsub``, then remove its files. |
| 73 | 73 |
| 74 Interaction with Mercurial Commands | 74 Interaction with Mercurial Commands |
| 75 ----------------------------------- | 75 =================================== |
| 76 | 76 |
| 77 :add: add does not recurse in subrepos unless -S/--subrepos is | 77 :add: add does not recurse in subrepos unless -S/--subrepos is |
| 78 specified. However, if you specify the full path of a file in a | 78 specified. However, if you specify the full path of a file in a |
| 79 subrepo, it will be added even without -S/--subrepos specified. | 79 subrepo, it will be added even without -S/--subrepos specified. |
| 80 Git and Subversion subrepositories are currently silently | 80 Git and Subversion subrepositories are currently silently |
| 130 changeset is not available in the current subrepository, Mercurial | 130 changeset is not available in the current subrepository, Mercurial |
| 131 will pull it in first before updating. This means that updating | 131 will pull it in first before updating. This means that updating |
| 132 can require network access when using subrepositories. | 132 can require network access when using subrepositories. |
| 133 | 133 |
| 134 Remapping Subrepositories Sources | 134 Remapping Subrepositories Sources |
| 135 --------------------------------- | 135 ================================= |
| 136 | 136 |
| 137 A subrepository source location may change during a project life, | 137 A subrepository source location may change during a project life, |
| 138 invalidating references stored in the parent repository history. To | 138 invalidating references stored in the parent repository history. To |
| 139 fix this, rewriting rules can be defined in parent repository ``hgrc`` | 139 fix this, rewriting rules can be defined in parent repository ``hgrc`` |
| 140 file or in Mercurial configuration. See the ``[subpaths]`` section in | 140 file or in Mercurial configuration. See the ``[subpaths]`` section in |