Show More
@@ -1,97 +1,103 b'' | |||||
1 | Synopsis |
|
1 | Synopsis | |
2 | ======== |
|
2 | ======== | |
3 |
|
3 | |||
4 | The Mercurial system uses a file called ``.hgignore`` in the root |
|
4 | The Mercurial system uses a file called ``.hgignore`` in the root | |
5 | directory of a repository to control its behavior when it searches |
|
5 | directory of a repository to control its behavior when it searches | |
6 | for files that it is not currently tracking. |
|
6 | for files that it is not currently tracking. | |
7 |
|
7 | |||
8 | Description |
|
8 | Description | |
9 | =========== |
|
9 | =========== | |
10 |
|
10 | |||
11 | The working directory of a Mercurial repository will often contain |
|
11 | The working directory of a Mercurial repository will often contain | |
12 | files that should not be tracked by Mercurial. These include backup |
|
12 | files that should not be tracked by Mercurial. These include backup | |
13 | files created by editors and build products created by compilers. |
|
13 | files created by editors and build products created by compilers. | |
14 | These files can be ignored by listing them in a ``.hgignore`` file in |
|
14 | These files can be ignored by listing them in a ``.hgignore`` file in | |
15 | the root of the working directory. The ``.hgignore`` file must be |
|
15 | the root of the working directory. The ``.hgignore`` file must be | |
16 | created manually. It is typically put under version control, so that |
|
16 | created manually. It is typically put under version control, so that | |
17 | the settings will propagate to other repositories with push and pull. |
|
17 | the settings will propagate to other repositories with push and pull. | |
18 |
|
18 | |||
19 | An untracked file is ignored if its path relative to the repository |
|
19 | An untracked file is ignored if its path relative to the repository | |
20 | root directory, or any prefix path of that path, is matched against |
|
20 | root directory, or any prefix path of that path, is matched against | |
21 | any pattern in ``.hgignore``. |
|
21 | any pattern in ``.hgignore``. | |
22 |
|
22 | |||
23 | For example, say we have an untracked file, ``file.c``, at |
|
23 | For example, say we have an untracked file, ``file.c``, at | |
24 | ``a/b/file.c`` inside our repository. Mercurial will ignore ``file.c`` |
|
24 | ``a/b/file.c`` inside our repository. Mercurial will ignore ``file.c`` | |
25 | if any pattern in ``.hgignore`` matches ``a/b/file.c``, ``a/b`` or ``a``. |
|
25 | if any pattern in ``.hgignore`` matches ``a/b/file.c``, ``a/b`` or ``a``. | |
26 |
|
26 | |||
27 | In addition, a Mercurial configuration file can reference a set of |
|
27 | In addition, a Mercurial configuration file can reference a set of | |
28 | per-user or global ignore files. See the ``ignore`` configuration |
|
28 | per-user or global ignore files. See the ``ignore`` configuration | |
29 | key on the ``[ui]`` section of :hg:`help config` for details of how to |
|
29 | key on the ``[ui]`` section of :hg:`help config` for details of how to | |
30 | configure these files. |
|
30 | configure these files. | |
31 |
|
31 | |||
32 | To control Mercurial's handling of files that it manages, many |
|
32 | To control Mercurial's handling of files that it manages, many | |
33 | commands support the ``-I`` and ``-X`` options; see |
|
33 | commands support the ``-I`` and ``-X`` options; see | |
34 | :hg:`help <command>` and :hg:`help patterns` for details. |
|
34 | :hg:`help <command>` and :hg:`help patterns` for details. | |
35 |
|
35 | |||
36 | Files that are already tracked are not affected by .hgignore, even |
|
36 | Files that are already tracked are not affected by .hgignore, even | |
37 | if they appear in .hgignore. An untracked file X can be explicitly |
|
37 | if they appear in .hgignore. An untracked file X can be explicitly | |
38 | added with :hg:`add X`, even if X would be excluded by a pattern |
|
38 | added with :hg:`add X`, even if X would be excluded by a pattern | |
39 | in .hgignore. |
|
39 | in .hgignore. | |
40 |
|
40 | |||
41 | Syntax |
|
41 | Syntax | |
42 | ====== |
|
42 | ====== | |
43 |
|
43 | |||
44 | An ignore file is a plain text file consisting of a list of patterns, |
|
44 | An ignore file is a plain text file consisting of a list of patterns, | |
45 | with one pattern per line. Empty lines are skipped. The ``#`` |
|
45 | with one pattern per line. Empty lines are skipped. The ``#`` | |
46 | character is treated as a comment character, and the ``\`` character |
|
46 | character is treated as a comment character, and the ``\`` character | |
47 | is treated as an escape character. |
|
47 | is treated as an escape character. | |
48 |
|
48 | |||
49 | Mercurial supports several pattern syntaxes. The default syntax used |
|
49 | Mercurial supports several pattern syntaxes. The default syntax used | |
50 | is Python/Perl-style regular expressions. |
|
50 | is Python/Perl-style regular expressions. | |
51 |
|
51 | |||
52 | To change the syntax used, use a line of the following form:: |
|
52 | To change the syntax used, use a line of the following form:: | |
53 |
|
53 | |||
54 | syntax: NAME |
|
54 | syntax: NAME | |
55 |
|
55 | |||
56 | where ``NAME`` is one of the following: |
|
56 | where ``NAME`` is one of the following: | |
57 |
|
57 | |||
58 | ``regexp`` |
|
58 | ``regexp`` | |
59 | Regular expression, Python/Perl syntax. |
|
59 | Regular expression, Python/Perl syntax. | |
60 | ``glob`` |
|
60 | ``glob`` | |
61 | Shell-style glob. |
|
61 | Shell-style glob. | |
62 | ``rootglob`` |
|
62 | ``rootglob`` | |
63 | A variant of ``glob`` that is rooted (see below). |
|
63 | A variant of ``glob`` that is rooted (see below). | |
64 |
|
64 | |||
65 | The chosen syntax stays in effect when parsing all patterns that |
|
65 | The chosen syntax stays in effect when parsing all patterns that | |
66 | follow, until another syntax is selected. |
|
66 | follow, until another syntax is selected. | |
67 |
|
67 | |||
68 | Neither ``glob`` nor regexp patterns are rooted. A glob-syntax |
|
68 | Neither ``glob`` nor regexp patterns are rooted. A glob-syntax | |
69 | pattern of the form ``*.c`` will match a file ending in ``.c`` in any |
|
69 | pattern of the form ``*.c`` will match a file ending in ``.c`` in any | |
70 | directory, and a regexp pattern of the form ``\.c$`` will do the |
|
70 | directory, and a regexp pattern of the form ``\.c$`` will do the | |
71 | same. To root a regexp pattern, start it with ``^``. To get the same |
|
71 | same. To root a regexp pattern, start it with ``^``. To get the same | |
72 | effect with glob-syntax, you have to use ``rootglob``. |
|
72 | effect with glob-syntax, you have to use ``rootglob``. | |
73 |
|
73 | |||
74 | Subdirectories can have their own .hgignore settings by adding |
|
74 | Subdirectories can have their own .hgignore settings by adding | |
75 | ``subinclude:path/to/subdir/.hgignore`` to the root ``.hgignore``. See |
|
75 | ``subinclude:path/to/subdir/.hgignore`` to the root ``.hgignore``. See | |
76 | :hg:`help patterns` for details on ``subinclude:`` and ``include:``. |
|
76 | :hg:`help patterns` for details on ``subinclude:`` and ``include:``. | |
77 |
|
77 | |||
78 | .. note:: |
|
78 | .. note:: | |
79 |
|
79 | |||
80 | Patterns specified in other than ``.hgignore`` are always rooted. |
|
80 | Patterns specified in other than ``.hgignore`` are always rooted. | |
81 | Please see :hg:`help patterns` for details. |
|
81 | Please see :hg:`help patterns` for details. | |
82 |
|
82 | |||
83 | Example |
|
83 | Example | |
84 | ======= |
|
84 | ======= | |
85 |
|
85 | |||
86 | Here is an example ignore file. :: |
|
86 | Here is an example ignore file. :: | |
87 |
|
87 | |||
88 | # use glob syntax. |
|
88 | # use glob syntax. | |
89 | syntax: glob |
|
89 | syntax: glob | |
90 |
|
90 | |||
91 | *.elc |
|
91 | *.elc | |
92 | *.pyc |
|
92 | *.pyc | |
93 | *~ |
|
93 | *~ | |
94 |
|
94 | |||
95 | # switch to regexp syntax. |
|
95 | # switch to regexp syntax. | |
96 | syntax: regexp |
|
96 | syntax: regexp | |
97 | ^\.pc/ |
|
97 | ^\.pc/ | |
|
98 | ||||
|
99 | Debugging | |||
|
100 | ========= | |||
|
101 | ||||
|
102 | Use the ``debugignore`` command to see if and why a file is ignored, or to | |||
|
103 | see the combined ignore pattern. See :hg:`help debugignore` for details. |
General Comments 0
You need to be logged in to leave comments.
Login now