[PATCH 6 of 6 STABLE] doc: unify section level between help topics for TOC in generated documents

FUJIWARA Katsunori foozy at lares.dti.ne.jp
Thu Apr 26 07:38:30 CDT 2012


# HG changeset patch
# User FUJIWARA Katsunori <foozy at lares.dti.ne.jp>
# Date 1335443568 -32400
# Branch stable
# Node ID a60e7e24b3486a93f619559df576835776975875
# Parent  5a697ab463387ab6e7c934765e7858730e8af97e
doc: unify section level between help topics for TOC in generated documents

some help topics use "-" for top level underlining section mark.

but "-" is used for top level categorization in generated documents
(e.g.: "hg.1.html"), 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.

see below WiKi page for detail:

http://mercurial.selenic.com/wiki/HelpStyleGuide#Sections

diff -r 5a697ab46338 -r a60e7e24b348 mercurial/help/hgignore.txt
--- a/mercurial/help/hgignore.txt	Thu Apr 26 21:32:48 2012 +0900
+++ b/mercurial/help/hgignore.txt	Thu Apr 26 21:32:48 2012 +0900
@@ -1,12 +1,12 @@
 Synopsis
---------
+""""""""
 
 The Mercurial system uses a file called ``.hgignore`` in the root
 directory of a repository to control its behavior when it searches
 for files that it is not currently tracking.
 
 Description
------------
+"""""""""""
 
 The working directory of a Mercurial repository will often contain
 files that should not be tracked by Mercurial. These include backup
@@ -34,7 +34,7 @@
 :hg:`help <command>` and :hg:`help patterns` for details.
 
 Syntax
-------
+""""""
 
 An ignore file is a plain text file consisting of a list of patterns,
 with one pattern per line. Empty lines are skipped. The ``#``
@@ -68,7 +68,7 @@
   Please see :hg:`help patterns` for details.
 
 Example
--------
+"""""""
 
 Here is an example ignore file. ::
 
diff -r 5a697ab46338 -r a60e7e24b348 mercurial/help/phases.txt
--- a/mercurial/help/phases.txt	Thu Apr 26 21:32:48 2012 +0900
+++ b/mercurial/help/phases.txt	Thu Apr 26 21:32:48 2012 +0900
@@ -1,5 +1,5 @@
 What are phases?
-----------------
+""""""""""""""""
 
 Phases are a system for tracking which changesets have been or should
 be shared. This helps prevent common mistakes when modifying history
@@ -17,7 +17,7 @@
 changeset phases should only be changed towards the public phase.
 
 How are phases managed?
------------------------
+"""""""""""""""""""""""
 
 For the most part, phases should work transparently. By default, a
 changeset is created in the draft phase and is moved into the public
@@ -29,7 +29,7 @@
 if needed. See :hg:`help -v phase` for examples.
 
 Phases and servers
-------------------
+""""""""""""""""""
 
 Normally, all servers are ``publishing`` by default. This means::
 
@@ -59,7 +59,7 @@
   publishing.
 
 Examples
---------
+""""""""
 
  - list changesets in draft or secret phase::
 
diff -r 5a697ab46338 -r a60e7e24b348 mercurial/help/subrepos.txt
--- a/mercurial/help/subrepos.txt	Thu Apr 26 21:32:48 2012 +0900
+++ b/mercurial/help/subrepos.txt	Thu Apr 26 21:32:48 2012 +0900
@@ -43,7 +43,7 @@
 
 
 Adding a Subrepository
-----------------------
+""""""""""""""""""""""
 
 If ``.hgsub`` does not exist, create it and add it to the parent
 repository. Clone or checkout the external projects where you want it
@@ -53,7 +53,7 @@
 ``.hgsubstate`` and bind it to the committed changeset.
 
 Synchronizing a Subrepository
------------------------------
+"""""""""""""""""""""""""""""
 
 Subrepos do not automatically track the latest changeset of their
 sources. Instead, they are updated to the changeset that corresponds
@@ -66,13 +66,13 @@
 commit in the parent repository to record the new combination.
 
 Deleting a Subrepository
-------------------------
+""""""""""""""""""""""""
 
 To remove a subrepository from the parent repository, delete its
 reference from ``.hgsub``, then remove its files.
 
 Interaction with Mercurial Commands
------------------------------------
+"""""""""""""""""""""""""""""""""""
 
 :add: add does not recurse in subrepos unless -S/--subrepos is
     specified.  However, if you specify the full path of a file in a
@@ -132,7 +132,7 @@
     can require network access when using subrepositories.
 
 Remapping Subrepositories Sources
----------------------------------
+"""""""""""""""""""""""""""""""""
 
 A subrepository source location may change during a project life,
 invalidating references stored in the parent repository history. To


More information about the Mercurial-devel mailing list