[PATCH] help: updated text in the config.txt file in reference to the [paths] section of hgrc, added example of alias for a local path

[JuanPi]

On Sat, Sep 29, 2012 at 12:44 AM, Matt Mackall <mpm at selenic.com> wrote:
> On Sat, 2012-09-29 at 00:17 +0200, Juan Pablo Carbajal wrote:
>> # HG changeset patch
>> # User Juan Pablo Carbajal (desktop) <carbajal at ifi.uzh.ch>
>> # Date 1348870138 -7200
>> # Node ID c94681d38ad1d8c4900b2046c427c4fceea6d12e
>> # Parent  5c89e7fa5bc20597080494aea43a09903e9e7a6a
>> help: updated text in the config.txt file in reference to the [paths] section of hgrc, added example of alias for a local path
>
> Summary too long.
>
>> diff -r 5c89e7fa5bc2 -r c94681d38ad1 mercurial/help/config.txt
>> --- a/mercurial/help/config.txt       Thu Sep 20 19:02:47 2012 +0200
>> +++ b/mercurial/help/config.txt       Sat Sep 29 00:08:58 2012 +0200
>> @@ -604,9 +604,9 @@
>>  ``post-<command>``
>>    Run after successful invocations of the associated command. The
>>    contents of the command line are passed as ``$HG_ARGS`` and the result
>> -  code in ``$HG_RESULT``. Parsed command line arguments are passed as
>> +  code in ``$HG_RESULT``. Parsed command line arguments are passed as
>>    ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
>> -  the python data internally passed to <command>. ``$HG_OPTS`` is a
>> +  the python data internally passed to <command>. ``$HG_OPTS`` is a
>>    dictionary of options (with unspecified options set to their defaults).
>>    ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
>
> Noise, not allowed.
>
>>
>> @@ -616,7 +616,7 @@
>>    are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
>>    representations of the data internally passed to <command>. ``$HG_OPTS``
>>    is a  dictionary of options (with unspecified options set to their
>> -  defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
>> +  defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
>>    failure, the command doesn't execute and Mercurial returns the failure
>>    code.
>
> Noise.
>
>> @@ -923,6 +923,17 @@
>>      Optional. Directory or URL to use when pushing if no destination
>>      is specified.
>>
>> +Custom paths can be defined by assigning the path to a name that later can be
>> +used from the command line. Example::
>> +
>> +    [paths]
>> +    default = default_path
>> +    local = ssh://server.local//path/to/repo
>
> Using an ssh url here is problematic. We should never show an ssh url
> without mentioning or implying the home-relative caveat, which is a
> distraction here.
>
>> +To push to the path defined in ``local`` use::
>> +
>> +    hg push local
>> +
>>  ``phases``
>>  ----------
>>
>> _______________________________________________
>> Mercurial-devel mailing list
>> Mercurial-devel at selenic.com
>> http://selenic.com/mailman/listinfo/mercurial-devel
>
>
> --
> Mathematics is the supreme nostalgia of our time.
>
>

Thank oyu for reviewing the patch.

The "niose" is due to trailing spaces in the given lines that are
erased at save time by my editor. Do you want to keep those trailing
spaces?
Let me know and I can prepare a patch with those trailing spaces left
as they are.

I can shorten the description, np.

I replaced the ssh path with "/path/to/repo". Is this ok? This example
could have saved a question in IRC. Is really a small detail, but it
would have been helpful for me.

Thanks

-- 
JuanPi Carbajal
-----
"It is one thing not to be able to perform a certain feat, but quite
another to prove that it cannot be done." - Henry Ernest Dudeney
-----
http://ailab.ifi.uzh.ch/carbajal/