diff options
Diffstat (limited to 'mercurial/help/hgignore.txt')
| -rw-r--r-- | mercurial/help/hgignore.txt | 17 |
1 files changed, 4 insertions, 13 deletions
diff --git a/mercurial/help/hgignore.txt b/mercurial/help/hgignore.txt index 3f82177..538f4b5 100644 --- a/mercurial/help/hgignore.txt +++ b/mercurial/help/hgignore.txt @@ -1,12 +1,12 @@ Synopsis -======== +-------- The Mercurial system uses a file called ``.hgignore`` in the root directory of a repository to control its behavior when it searches for files that it is not currently tracking. Description -=========== +----------- The working directory of a Mercurial repository will often contain files that should not be tracked by Mercurial. These include backup @@ -33,13 +33,8 @@ To control Mercurial's handling of files that it manages, many commands support the ``-I`` and ``-X`` options; see :hg:`help <command>` and :hg:`help patterns` for details. -Files that are already tracked are not affected by .hgignore, even -if they appear in .hgignore. An untracked file X can be explicitly -added with :hg:`add X`, even if X would be excluded by a pattern -in .hgignore. - Syntax -====== +------ An ignore file is a plain text file consisting of a list of patterns, with one pattern per line. Empty lines are skipped. The ``#`` @@ -68,12 +63,8 @@ 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 ``^``. -.. note:: - Patterns specified in other than ``.hgignore`` are always rooted. - Please see :hg:`help patterns` for details. - Example -======= +------- Here is an example ignore file. :: |