[PATCH] hgignore.5.txt: improved description of matching

[Martin Geisler]

Henri Wiechers <hwiechers at gmail.com> writes:

> # HG changeset patch
> # User Henri Wiechers <hwiechers at gmail.com>
> # Date 1247320594 -7200
> # Node ID 9978b47f5d4e975c0b9996139af5583cb94aa8fc
> # Parent  ac3f1e6696eb01cfe24c01bad44d5c54aca495a7
> hgignore.5.txt: improved description of matching
>
> Improved the description of the matching behavior used with .hgignore.
> Made some minor language improvements.
> Left out some unnecessary details.

Is that the -I and -X bit? I think it's good to have a pointer to those
options.

> diff -r ac3f1e6696eb -r 9978b47f5d4e doc/hgignore.5.txt
> --- a/doc/hgignore.5.txt	Fri Jul 10 23:24:35 2009 +0200
> +++ b/doc/hgignore.5.txt	Sat Jul 11 15:56:34 2009 +0200
> @@ -12,16 +12,20 @@
>  --------
>  
>  The Mercurial system uses a file called `.hgignore` in the root
> -directory of a repository to control its behavior when it finds files
> -that it is not currently managing.
> +directory of a repository to control its behavior when it searches
> +for files that it is not currently tracking.
>  
>  DESCRIPTION
>  -----------
>  
> -Mercurial ignores every unmanaged file that matches any pattern in an
> -ignore file. The patterns in an ignore file do not apply to files
> -managed by Mercurial. To control Mercurial's handling of files that it
> -manages, see the hg(1) man page. Look for the "-I" and "-X" options.
> +An untracked file is ignored if its path relative to the repository
> +root directory, or any prefix path of that path, is matched against
> +any pattern in .hgignore.
> +
> +For example, say there is a repository at `/home/me/repo` with 
> +an untracked file, `file.c`, at `/home/me/repo/a/b/file.c`. 
> +Mercurial will ignore `file.c` if any pattern in 
> +`/home/me/repo/.hgignore` matches `a/b/file.c`, `a/b` or `a`.

It's very nice with an example. I think it would just as clear if the
location of the repository is not mentioned:

  For example, say we have an untracked file, `file.c` in
  `<repo>/a/b/file.c`. Mercurial will ignore `file.c` if any pattern in
  `<repo>/.hgignore` matches `a/b/file.c`, `a/b` or `a`.

Maybe we dont need the <repo> at all -- the rest of hgignore.5.txt
doesn't use it.

-- 
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/20090711/0a7b3666/attachment.pgp