From patchwork Sun Jan 10 18:51:18 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: [4,of,6] help: label windows config help From: timeless@mozdev.org X-Patchwork-Id: 12627 Message-Id: <9647c8b7380e26600b71.1452451878@waste.org> To: mercurial-devel@selenic.com Date: Sun, 10 Jan 2016 12:51:18 -0600 # HG changeset patch # User timeless # Date 1452406150 0 # Sun Jan 10 06:09:10 2016 +0000 # Node ID 9647c8b7380e26600b713685a1600c87fa8091d5 # Parent a3bc3e184ae46fb37b49f450c82c7d59d1ff991e help: label windows config help diff --git a/mercurial/help/config.txt b/mercurial/help/config.txt --- a/mercurial/help/config.txt +++ b/mercurial/help/config.txt @@ -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. ```` is the @@ -523,11 +526,13 @@ of an empty temporary file, where the filtered data must be written by the command. -.. note:: +.. container:: windows - 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. + .. 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. This filter mechanism is used internally by the ``eol`` extension to translate line ending characters between Windows (CRLF) and Unix (LF) @@ -1057,8 +1062,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`` @@ -1106,27 +1116,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 -``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) + ``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) -``regname`` - Name of value to read from specified registry key. - (default: the unnamed (default) value) + ``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) -``regappend`` - String to append to the value read from the registry, typically - the executable name of the tool. - (default: None) + ``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) ``patch`` @@ -1611,7 +1623,7 @@ ``false`` Alias for ``ignore``. - .. container:: + .. container:: windows On Windows, this configuration option is ignored and the command aborted.