Patchwork [5,of,5,STABLE] doc: itemize text blocks to increase readability in HTML format

login
register
mail settings
Submitter Katsunori FUJIWARA
Date Feb. 1, 2016, 1:15 p.m.
Message ID <aaf1555aeb7f46255ece.1454332506@feefifofum>
Download mbox | patch
Permalink /patch/12930/
State Accepted
Delegated to: Yuya Nishihara
Headers show

Comments

Katsunori FUJIWARA - Feb. 1, 2016, 1:15 p.m.
# HG changeset patch
# User FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
# Date 1454332446 -32400
#      Mon Feb 01 22:14:06 2016 +0900
# Branch stable
# Node ID aaf1555aeb7f46255ece2cdca6829d11cb634c16
# Parent  b112463031ad73fcbb63fc2dd3834e73e662df98
doc: itemize text blocks to increase readability in HTML format

Before this patch, text blocks changed in this patch are shown as just
continuous text blocks like below in HTML format.

    Global configuration like the username setting is typically put into:

    %USERPROFILE%\mercurial.ini
    $HOME/.hgrc

This patch itemizes these text blocks to increase readability in HTML
format.

    Global configuration like the username setting is typically put into:

    - %USERPROFILE%\mercurial.ini (on Windows)
    - $HOME/.hgrc (on Unix, Plan9)

Like as other platform sensitive container-ed text blocks, this patch
also adds explicit "on PLATFORM" information to each items for
readability in HTML format, even though output of "hg help config" on
command line seems a little redundant. For example, on Unix:

    Global configuration like the username setting is typically put into:

    - "$HOME/.hgrc" (on Unix, Plan9)
Pierre-Yves David - Feb. 1, 2016, 1:56 p.m.
On 02/01/2016 01:15 PM, FUJIWARA Katsunori wrote:
> # HG changeset patch
> # User FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
> # Date 1454332446 -32400
> #      Mon Feb 01 22:14:06 2016 +0900
> # Branch stable
> # Node ID aaf1555aeb7f46255ece2cdca6829d11cb634c16
> # Parent  b112463031ad73fcbb63fc2dd3834e73e662df98
> doc: itemize text blocks to increase readability in HTML format

Pushed to the clowcopter, thanks!

Patch

diff --git a/mercurial/help/config.txt b/mercurial/help/config.txt
--- a/mercurial/help/config.txt
+++ b/mercurial/help/config.txt
@@ -38,11 +38,11 @@  Global configuration like the username s
 
 .. container:: windows
 
-  ``%USERPROFILE%\mercurial.ini``
+  - ``%USERPROFILE%\mercurial.ini`` (on Windows)
 
 .. container:: unix.plan9
 
-  ``$HOME/.hgrc``
+  - ``$HOME/.hgrc`` (on Unix, Plan9)
 
 The names of these files depend on the system on which Mercurial is
 installed. ``*.rc`` files from a single directory are read in