Patchwork [4,of,6] help: label windows config help

login
register
mail settings
Submitter timeless@mozdev.org
Date Jan. 10, 2016, 6:51 p.m.
Message ID <9647c8b7380e26600b71.1452451878@waste.org>
Download mbox | patch
Permalink /patch/12627/
State Accepted
Headers show

Comments

timeless@mozdev.org - Jan. 10, 2016, 6:51 p.m.
# HG changeset patch
# User timeless <timeless@mozdev.org>
# Date 1452406150 0
#      Sun Jan 10 06:09:10 2016 +0000
# Node ID 9647c8b7380e26600b713685a1600c87fa8091d5
# Parent  a3bc3e184ae46fb37b49f450c82c7d59d1ff991e
help: label windows config help
Danek Duvall - Jan. 14, 2016, 11:44 p.m.
timeless wrote:

> # HG changeset patch
> # User timeless <timeless@mozdev.org>
> # 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.

I was just looking at this.  Is anything but the first sentence specific to
Windows?  I'd assumed the rest of the paragraph was generic.

Thanks,
Danek
timeless - Jan. 15, 2016, 2:51 a.m.
On Jan 14, 2016 6:51 PM, "Danek Duvall" <danek.duvall@oracle.com> wrote:
>
> timeless wrote:
>
> > # HG changeset patch
> > # User timeless <timeless@mozdev.org>
> > # 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.
>
> I was just looking at this.  Is anything but the first sentence specific
to
> Windows?  I'd assumed the rest of the paragraph was generic.

I had a hard time figuring out which was and which wasn't. Reading it
again, I think you're correct. We can move the last two sentences out into
the preceding block.

I won't be able to send a patch before next Wednesday.
Danek Duvall - Jan. 15, 2016, 3:04 a.m.
timeless wrote:

> > > +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.
> >
> > I was just looking at this.  Is anything but the first sentence
> > specific to Windows?  I'd assumed the rest of the paragraph was
> > generic.
> 
> I had a hard time figuring out which was and which wasn't. Reading it
> again, I think you're correct. We can move the last two sentences out into
> the preceding block.
> 
> I won't be able to send a patch before next Wednesday.

I can send one out tomorrow, if you like.

Danek
timeless - Jan. 15, 2016, 3:35 a.m.
Sure, thanks
On Jan 14, 2016 10:11 PM, "Danek Duvall" <danek.duvall@oracle.com> wrote:

> timeless wrote:
>
> > > > +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.
> > >
> > > I was just looking at this.  Is anything but the first sentence
> > > specific to Windows?  I'd assumed the rest of the paragraph was
> > > generic.
> >
> > I had a hard time figuring out which was and which wasn't. Reading it
> > again, I think you're correct. We can move the last two sentences out
> into
> > the preceding block.
> >
> > I won't be able to send a patch before next Wednesday.
>
> I can send one out tomorrow, if you like.
>
> Danek
>

Patch

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. ``<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
 
-   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.