Patchwork [1,of,6,stable] help: use strip instead of mq as in 'hg help config' example

login
register
mail settings
Submitter Martin Geisler
Date Nov. 23, 2013, 7:02 p.m.
Message ID <62bc6f9d0080426eaa7c.1385233372@hbox.dyndns.org>
Download mbox | patch
Permalink /patch/3106/
State Superseded
Headers show

Comments

Martin Geisler - Nov. 23, 2013, 7:02 p.m.
# HG changeset patch
# User Martin Geisler <martin@geisler.net>
# Date 1385136763 -3600
#      Fri Nov 22 17:12:43 2013 +0100
# Branch stable
# Node ID 62bc6f9d0080426eaa7cafd4f5f051ca2efd3a13
# Parent  06ef32c3b4bb2974749eefa171434903fe887e46
help: use strip instead of mq as in 'hg help config' example

Most users enable the MQ extension to get access to 'hg strip', so we
can help them by showing them the strip extension instead of MQ.
Augie Fackler - Nov. 27, 2013, 3:26 p.m.
On Sat, Nov 23, 2013 at 08:02:52PM +0100, Martin Geisler wrote:
> # HG changeset patch
> # User Martin Geisler <martin@geisler.net>
> # Date 1385136763 -3600
> #      Fri Nov 22 17:12:43 2013 +0100
> # Branch stable
> # Node ID 62bc6f9d0080426eaa7cafd4f5f051ca2efd3a13
> # Parent  06ef32c3b4bb2974749eefa171434903fe887e46
> help: use strip instead of mq as in 'hg help config' example

Are help edits like this really right for stable?

>
> Most users enable the MQ extension to get access to 'hg strip', so we
> can help them by showing them the strip extension instead of MQ.
>
> diff --git a/mercurial/help/config.txt b/mercurial/help/config.txt
> --- a/mercurial/help/config.txt
> +++ b/mercurial/help/config.txt
> @@ -495,8 +495,8 @@
>  Example for ``~/.hgrc``::
>
>    [extensions]
> -  # (the mq extension will get loaded from Mercurial's path)
> -  mq =
> +  # (the strip extension will get loaded from Mercurial's path)
> +  strip =
>    # (this extension will get loaded from the file specified)
>    myfeature = ~/.hgext/myfeature.py
>
> _______________________________________________
> Mercurial-devel mailing list
> Mercurial-devel@selenic.com
> http://selenic.com/mailman/listinfo/mercurial-devel
Pierre-Yves David - Nov. 27, 2013, 6:22 p.m.
On 11/27/2013 07:26 AM, Augie Fackler wrote:
> On Sat, Nov 23, 2013 at 08:02:52PM +0100, Martin Geisler wrote:
>> # HG changeset patch
>> # User Martin Geisler <martin@geisler.net>
>> # Date 1385136763 -3600
>> #      Fri Nov 22 17:12:43 2013 +0100
>> # Branch stable
>> # Node ID 62bc6f9d0080426eaa7cafd4f5f051ca2efd3a13
>> # Parent  06ef32c3b4bb2974749eefa171434903fe887e46
>> help: use strip instead of mq as in 'hg help config' example
> Are help edits like this really right for stable?

Probably not. This seems non-critical (and that me talking about getting 
rid of an MQ reference). And that will break translation if I'm remember 
correctly.
Martin Geisler - Nov. 27, 2013, 10:43 p.m.
Augie Fackler <raf@durin42.com> writes:

> On Sat, Nov 23, 2013 at 08:02:52PM +0100, Martin Geisler wrote:
>> # HG changeset patch
>> # User Martin Geisler <martin@geisler.net>
>> # Date 1385136763 -3600
>> #      Fri Nov 22 17:12:43 2013 +0100
>> # Branch stable
>> # Node ID 62bc6f9d0080426eaa7cafd4f5f051ca2efd3a13
>> # Parent  06ef32c3b4bb2974749eefa171434903fe887e46
>> help: use strip instead of mq as in 'hg help config' example
>
> Are help edits like this really right for stable?

We have a tradition of making improvements to the documentation on the
stable branch. I was counting the change as that.

It doesn't really matter -- the patches can go on either branch and you
can pick and choose among them as you like. I don't think they have any
real interdependencies.

>> Most users enable the MQ extension to get access to 'hg strip', so we
>> can help them by showing them the strip extension instead of MQ.
>>
>> diff --git a/mercurial/help/config.txt b/mercurial/help/config.txt
>> --- a/mercurial/help/config.txt
>> +++ b/mercurial/help/config.txt
>> @@ -495,8 +495,8 @@
>>  Example for ``~/.hgrc``::
>>
>>    [extensions]
>> -  # (the mq extension will get loaded from Mercurial's path)
>> -  mq =
>> +  # (the strip extension will get loaded from Mercurial's path)
>> +  strip =
>>    # (this extension will get loaded from the file specified)
>>    myfeature = ~/.hgext/myfeature.py
>>
>> _______________________________________________
>> Mercurial-devel mailing list
>> Mercurial-devel@selenic.com
>> http://selenic.com/mailman/listinfo/mercurial-devel
> _______________________________________________
> Mercurial-devel mailing list
> Mercurial-devel@selenic.com
> http://selenic.com/mailman/listinfo/mercurial-devel
Matt Mackall - Dec. 1, 2013, 7:02 p.m.
On Wed, 2013-11-27 at 10:26 -0500, Augie Fackler wrote:
> On Sat, Nov 23, 2013 at 08:02:52PM +0100, Martin Geisler wrote:
> > # HG changeset patch
> > # User Martin Geisler <martin@geisler.net>
> > # Date 1385136763 -3600
> > #      Fri Nov 22 17:12:43 2013 +0100
> > # Branch stable
> > # Node ID 62bc6f9d0080426eaa7cafd4f5f051ca2efd3a13
> > # Parent  06ef32c3b4bb2974749eefa171434903fe887e46
> > help: use strip instead of mq as in 'hg help config' example
> 
> Are help edits like this really right for stable?

Yes. Here is the set of things that are acceptable:

 * bug fixes 
 * error message improvements
 * doc fixes 
 * template fixes 
 * improved translations 

http://mercurial.selenic.com/wiki/TimeBasedReleasePlan

The question you should ask yourself when evaluating something for
stable is "what is the ratio of end-user reward vs upgrade risk?"

The risk ratio for doc cleanups is quite good as there's very little
risk that they'll ruin a user's day after an upgrade, but there's a
decent chance they'll make a user's day better.

By comparison, the opposite is true for "trivial code cleanups": they
intentionally have no user-visible benefits but they're often not quite
as trivial as you think.
Matt Mackall - Dec. 1, 2013, 7:16 p.m.
On Sat, 2013-11-23 at 20:02 +0100, Martin Geisler wrote:
> # HG changeset patch
> # User Martin Geisler <martin@geisler.net>
> # Date 1385136763 -3600
> #      Fri Nov 22 17:12:43 2013 +0100
> # Branch stable
> # Node ID 62bc6f9d0080426eaa7cafd4f5f051ca2efd3a13
> # Parent  06ef32c3b4bb2974749eefa171434903fe887e46
> help: use strip instead of mq as in 'hg help config' example

These are queued, thanks. I've changed this first one to mention
progress instead as it's much harder to shoot yourself in the foot with.

Patch

diff --git a/mercurial/help/config.txt b/mercurial/help/config.txt
--- a/mercurial/help/config.txt
+++ b/mercurial/help/config.txt
@@ -495,8 +495,8 @@ 
 Example for ``~/.hgrc``::
 
   [extensions]
-  # (the mq extension will get loaded from Mercurial's path)
-  mq =
+  # (the strip extension will get loaded from Mercurial's path)
+  strip =
   # (this extension will get loaded from the file specified)
   myfeature = ~/.hgext/myfeature.py