|
Size: 2694
Comment: dump of the hgignore(5) manpage bundled with mercurial 0.9
|
Size: 1640
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| The `.hgignore` file sits in the WorkingDirectory, next to the `.hg` folder. | The `.hgignore` file sits in the [[WorkingDirectory|working directory]], next to the `.hg` folder. |
| Line 6: | Line 6: |
| for any command operating on the WorkingDirectory. | for any command operating on the working directory. |
| Line 8: | Line 8: |
| == Corresponding Man Page == | Man Page: [[http://www.selenic.com/mercurial/hgignore.5.html|hgignore(5)]] == How it works == Each path within the repository is presented to the ignore pattern matcher, so it would be presented with something like this: |
| Line 10: | Line 15: |
| HGIGNORE(5) =========== Vadim Gelfer <vadim.gelfer@gmail.com> |
code code/something code/targets code/targets/platform target target/executable }}} |
| Line 14: | Line 23: |
| NAME ---- hgignore - syntax for Mercurial ignore files |
This is just like the output of the Unix `find` command. To match only `target` at the top level of a repository, you would use this in `.hgignore` (using the `regex` syntax): |
| Line 18: | Line 25: |
| SYNOPSIS -------- |
{{{ ^target$ }}} |
| Line 21: | Line 29: |
| 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. |
To match anything called `target` elsewhere in the repository, you would need to have something like this: |
| Line 25: | Line 31: |
| DESCRIPTION ----------- |
{{{ /target$ }}} |
| Line 28: | Line 35: |
| 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. |
The above pattern will ignore files and whole directories (by "pruning" those directories and thus ignoring their contents). If you need to ignore the contents of a directory, which is not in itself particularly useful, you would start with this pattern: |
| Line 34: | Line 37: |
| In addition, a Mercurial configuration file can point to 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. |
{{{ /target/ }}} |
| Line 39: | Line 41: |
| SYNTAX ------ |
Since the above pattern would only appear in paths for files below a directory called `target`, it would only match those files, not the directory itself. You could then extend this pattern to match specific files, however: |
| Line 42: | Line 43: |
| An ignore file is a plain text file consisting of a list of patterns, 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. |
{{{ /target/.*\.o$ }}} |
| Line 47: | Line 47: |
| Mercurial supports several pattern syntaxes. The default syntax used 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. Neither glob nor regexp patterns are rooted. A glob-syntax pattern of 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 "^". EXAMPLE ------- Here is an example ignore file. # use glob syntax. syntax: glob *.elc *.pyc *~ .*.swp # 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. Mercurial is copyright 2005, 2006 Matt Mackall. Free use of this software is granted under the terms of the GNU General Public License (GPL). }}} |
This would match all files ending with `.o` below (within and in subdirectories at any depth of) the `target` directory. |
.hgignore
The .hgignore file sits in the working directory, next to the .hg folder. It is a file versioned as any other versioned file in the working directory, which is used to hold the content of the ignore patterns that are used for any command operating on the working directory.
Man Page: hgignore(5)
1. How it works
Each path within the repository is presented to the ignore pattern matcher, so it would be presented with something like this:
code code/something code/targets code/targets/platform target target/executable
This is just like the output of the Unix find command. To match only target at the top level of a repository, you would use this in .hgignore (using the regex syntax):
^target$
To match anything called target elsewhere in the repository, you would need to have something like this:
/target$
The above pattern will ignore files and whole directories (by "pruning" those directories and thus ignoring their contents). If you need to ignore the contents of a directory, which is not in itself particularly useful, you would start with this pattern:
/target/
Since the above pattern would only appear in paths for files below a directory called target, it would only match those files, not the directory itself. You could then extend this pattern to match specific files, however:
/target/.*\.o$
This would match all files ending with .o below (within and in subdirectories at any depth of) the target directory.