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

Henri Wiechers hwiechers at gmail.com
Sun Jul 12 01:27:35 CDT 2009


# HG changeset patch
# User Henri Wiechers <hwiechers at gmail.com>
# Date 1247378203 -7200
# Node ID 5180b793aca875d18b411f92c47b9155e09e0de7
# Parent  ac3f1e6696eb01cfe24c01bad44d5c54aca495a7
hgignore.5.txt: improved description of matching

Improved the description of the matching behavior used with .hgignore.
Made some minor language improvements.

diff -r ac3f1e6696eb -r 5180b793aca8 doc/hgignore.5.txt
--- a/doc/hgignore.5.txt	Fri Jul 10 23:24:35 2009 +0200
+++ b/doc/hgignore.5.txt	Sun Jul 12 07:56:43 2009 +0200
@@ -12,22 +12,28 @@
 --------
 
 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`.
 
-In addition, a Mercurial configuration file can point to a set of
+For example, say we have an an untracked file, `file.c`, at 
+`a/b/file.c` inside our repository. Mercurial will ignore `file.c` if
+any pattern in `.hgignore` matches `a/b/file.c`, `a/b` or `a`.
+
+In addition, a Mercurial configuration file can reference a set of
 per-user or global ignore files. See the hgrc(5) man page for details
 of how to configure these files. Look for the "ignore" entry in the
 "ui" section.
 
+To control Mercurial's handling of files that it manages, see the
+hg(1) man page. Look for the "-I" and "-X" options.
+
 SYNTAX
 ------
 


More information about the Mercurial-devel mailing list