hgignore.5.txt
92 lines
| 2.3 KiB
| text/plain
|
TextLexer
/ doc / hgignore.5.txt
|
r2209 | HGIGNORE(5) | ||
=========== | ||||
Vadim Gelfer <vadim.gelfer@gmail.com> | ||||
|
r8772 | :man source: Mercurial | ||
:man manual: Mercurial Manual | ||||
|
r2209 | |||
NAME | ||||
---- | ||||
hgignore - syntax for Mercurial ignore files | ||||
SYNOPSIS | ||||
-------- | ||||
|
r8766 | The Mercurial system uses a file called `.hgignore` in the root | ||
|
r2209 | directory of a repository to control its behavior when it finds files | ||
that it is not currently managing. | ||||
DESCRIPTION | ||||
----------- | ||||
Mercurial ignores every unmanaged file that matches any pattern in an | ||||
|
r6446 | ignore file. The patterns in an ignore file do not apply to files | ||
|
r8729 | 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. | ||||
|
r2209 | |||
In addition, a Mercurial configuration file can point to a set of | ||||
|
r6446 | 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 | ||||
|
r2209 | "ui" section. | ||
SYNTAX | ||||
------ | ||||
An ignore file is a plain text file consisting of a list of patterns, | ||||
|
r8782 | with one pattern per line. Empty lines are skipped. The "`#`" | ||
character is treated as a comment character, and the "`\`" character | ||||
is treated as an escape character. | ||||
|
r2209 | |||
|
r6446 | Mercurial supports several pattern syntaxes. The default syntax used | ||
|
r2209 | is Python/Perl-style regular expressions. | ||
To change the syntax used, use a line of the following form: | ||||
syntax: NAME | ||||
where NAME is one of the following: | ||||
regexp:: | ||||
Regular expression, Python/Perl syntax. | ||||
glob:: | ||||
Shell-style glob. | ||||
The chosen syntax stays in effect when parsing all patterns that | ||||
follow, until another syntax is selected. | ||||
|
r6446 | Neither glob nor regexp patterns are rooted. A glob-syntax pattern of | ||
|
r8782 | the form "`*.c`" will match a file ending in "`.c`" in any directory, | ||
and a regexp pattern of the form "`\.c$`" will do the same. To root a | ||||
regexp pattern, start it with "`^`". | ||||
|
r2209 | |||
EXAMPLE | ||||
------- | ||||
Here is an example ignore file. | ||||
# use glob syntax. | ||||
syntax: glob | ||||
*.elc | ||||
*.pyc | ||||
*~ | ||||
# switch to regexp syntax. | ||||
syntax: regexp | ||||
^\.pc/ | ||||
AUTHOR | ||||
------ | ||||
Vadim Gelfer <vadim.gelfer@gmail.com> | ||||
Mercurial was written by Matt Mackall <mpm@selenic.com>. | ||||
SEE ALSO | ||||
-------- | ||||
hg(1), hgrc(5) | ||||
COPYING | ||||
------- | ||||
This manual page is copyright 2006 Vadim Gelfer. | ||||
|
r8771 | Mercurial is copyright 2005-2009 Matt Mackall. | ||
|
r2209 | Free use of this software is granted under the terms of the GNU General | ||
Public License (GPL). | ||||