changeset 27761:bf8b0796af2e

help: label windows config help
author timeless <timeless@mozdev.org>
date Sun, 10 Jan 2016 06:09:10 +0000
parents df4894651532
children 70e7bfebba46
files mercurial/help/config.txt
diffstat 1 files changed, 42 insertions(+), 30 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/help/config.txt	Sun Jan 10 06:08:41 2016 +0000
+++ b/mercurial/help/config.txt	Sun Jan 10 06:09:10 2016 +0000
@@ -95,11 +95,14 @@
   belong to a trusted user or to a trusted group. See
   :hg:`help config.trusted` for more details.
 
-Per-user configuration file(s) are for the user running Mercurial. On
-Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in these
-files apply to all Mercurial commands executed by this user in any
-directory. Options in these files override per-system and per-installation
-options.
+Per-user configuration file(s) are for the user running Mercurial.
+
+.. container:: windows
+
+  On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in
+  these files apply to all Mercurial commands executed by this user in
+  any directory. Options in these files override per-system and
+  per-installation options.
 
 Per-installation configuration files are searched for in the
 directory where Mercurial is installed. ``<install-root>`` is the
@@ -523,11 +526,13 @@
 of an empty temporary file, where the filtered data must be written by
 the command.
 
-.. note::
+.. container:: windows
+
+   .. note::
 
-   The tempfile mechanism is recommended for Windows systems,
-   where the standard shell I/O redirection operators often have
-   strange effects and may corrupt the contents of your files.
+     The tempfile mechanism is recommended for Windows systems,
+     where the standard shell I/O redirection operators often have
+     strange effects and may corrupt the contents of your files.
 
 This filter mechanism is used internally by the ``eol`` extension to
 translate line ending characters between Windows (CRLF) and Unix (LF)
@@ -1061,8 +1066,13 @@
   (default: 0)
 
 ``executable``
-  Either just the name of the executable or its pathname.  On Windows,
-  the path can use environment variables with ${ProgramFiles} syntax.
+  Either just the name of the executable or its pathname.
+
+  .. container:: windows
+
+    On Windows, the path can use environment variables with ${ProgramFiles}
+    syntax.
+
   (default: the tool name)
 
 ``args``
@@ -1110,27 +1120,29 @@
 ``gui``
   This tool requires a graphical interface to run. (default: False)
 
-``regkey``
-  Windows registry key which describes install location of this
-  tool. Mercurial will search for this key first under
-  ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
-  (default: None)
+.. container:: windows
+
+  ``regkey``
+    Windows registry key which describes install location of this
+    tool. Mercurial will search for this key first under
+    ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
+    (default: None)
 
-``regkeyalt``
-  An alternate Windows registry key to try if the first key is not
-  found.  The alternate key uses the same ``regname`` and ``regappend``
-  semantics of the primary key.  The most common use for this key
-  is to search for 32bit applications on 64bit operating systems.
-  (default: None)
+  ``regkeyalt``
+    An alternate Windows registry key to try if the first key is not
+    found.  The alternate key uses the same ``regname`` and ``regappend``
+    semantics of the primary key.  The most common use for this key
+    is to search for 32bit applications on 64bit operating systems.
+    (default: None)
 
-``regname``
-  Name of value to read from specified registry key.
-  (default: the unnamed (default) value)
+  ``regname``
+    Name of value to read from specified registry key.
+    (default: the unnamed (default) value)
 
-``regappend``
-  String to append to the value read from the registry, typically
-  the executable name of the tool.
-  (default: None)
+  ``regappend``
+    String to append to the value read from the registry, typically
+    the executable name of the tool.
+    (default: None)
 
 
 ``patch``
@@ -1656,7 +1668,7 @@
     ``false``
       Alias for ``ignore``.
 
-    .. container::
+    .. container:: windows
 
       On Windows, this configuration option is ignored and the command aborted.