[PATCH] update documentation for URLs to provide more detail on trailing '#'

[Martin Geisler]

Mark Edgington <edgimar at gmail.com> writes:

> # HG changeset patch
> # User Mark Edgington <edgimar at gmail.com>
> # Date 1244196308 -7200
> # Node ID 1d26c51de9a7f40ceaefab894822b9fadcaceaee
> # Parent  b5e9ed63913b2d953eb7f6fd704b5e356fa53642
> update documentation for URLs to provide more detail on trailing '#'
>
> diff --git a/mercurial/help.py b/mercurial/help.py
> --- a/mercurial/help.py
> +++ b/mercurial/help.py
> @@ -362,17 +362,18 @@
>       _(r'''
>      Valid URLs are of the form:
>  
> -      local/filesystem/path (or file://local/filesystem/path)
> -      http://[user[:pass]@]host[:port]/[path]
> -      https://[user[:pass]@]host[:port]/[path]
> -      ssh://[user[:pass]@]host[:port]/[path]
> +      local/filesystem/path[#<identifier>] (or file://local/filesystem/path)
> +      http://[user[:pass]@]host[:port]/[path][#<identifier>]
> +      https://[user[:pass]@]host[:port]/[path][#<identifier>]
> +      ssh://[user[:pass]@]host[:port]/[path][#<identifier>]

It is unfortunate that these lines are so complicated (four optional
groups, one with a nested optional group...). But I think we should
apply this hunk anyway since it makes the documentation more acurate.

>      Paths in the local filesystem can either point to Mercurial
>      repositories or to bundle files (as created by 'hg bundle' or
>      'hg incoming --bundle').
>  
> -    An optional identifier after # indicates a particular branch, tag,
> -    or changeset to use from the remote repository.
> +    An optional identifier after a trailing # indicates a particular branch,
> +    tag, or changeset / bookmark to use when pushing to / pulling from the
> +    remote repository.

Why the slash with 'bookmark'?

Also, the bookmarks extension is still an extension, so I don't think
the core help file should reference it. Instead, and I guess it already
does this, the extension should explain that bookmarks can be used
whereever a changeset is needed.

-- 
Martin Geisler

VIFF (Virtual Ideal Functionality Framework) brings easy and efficient
SMPC (Secure Multiparty Computation) to Python. See: http://viff.dk/.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 196 bytes
Desc: not available
Url : http://selenic.com/pipermail/mercurial-devel/attachments/20090607/e064f576/attachment.pgp