Mercurial > hg

comparison doc/hgignore.5.txt @ 9158:d6eecafaf12f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
author Martin Geisler <mg@lazybytes.net>
date Thu, 16 Jul 2009 23:25:26 +0200
parents 35c3f94233a0
children e8b653a4b8da
comparison
equal deleted inserted replaced
9157:9261667e9b82 9158:d6eecafaf12f
1 HGIGNORE(5) 1 ==========
2 =========== 2 hgignore
3 Vadim Gelfer <vadim.gelfer@gmail.com> 3 ==========
4 :man source: Mercurial
5 :man manual: Mercurial Manual
6 4
7 NAME 5 ---------------------------------
8 ---- 6 syntax for Mercurial ignore files
9 hgignore - syntax for Mercurial ignore files 7 ---------------------------------
8
9 :Author: Vadim Gelfer <vadim.gelfer@gmail.com>
10 :Organization: Mercurial
11 :Manual section: 5
12 :Manual group: Mercurial Manual
10 13
11 SYNOPSIS 14 SYNOPSIS
12 -------- 15 --------
13 16
14 The Mercurial system uses a file called `.hgignore` in the root 17 The Mercurial system uses a file called ``.hgignore`` in the root
15 directory of a repository to control its behavior when it searches 18 directory of a repository to control its behavior when it searches
16 for files that it is not currently tracking. 19 for files that it is not currently tracking.
17 20
18 DESCRIPTION 21 DESCRIPTION
19 ----------- 22 -----------
36 39
37 SYNTAX 40 SYNTAX
38 ------ 41 ------
39 42
40 An ignore file is a plain text file consisting of a list of patterns, 43 An ignore file is a plain text file consisting of a list of patterns,
41 with one pattern per line. Empty lines are skipped. The "`#`" 44 with one pattern per line. Empty lines are skipped. The "``#``"
42 character is treated as a comment character, and the "`\`" character 45 character is treated as a comment character, and the "``\``" character
43 is treated as an escape character. 46 is treated as an escape character.
44 47
45 Mercurial supports several pattern syntaxes. The default syntax used 48 Mercurial supports several pattern syntaxes. The default syntax used
46 is Python/Perl-style regular expressions. 49 is Python/Perl-style regular expressions.
47 50
48 To change the syntax used, use a line of the following form: 51 To change the syntax used, use a line of the following form::
49 52
50 syntax: NAME 53 syntax: NAME
51 54
52 where NAME is one of the following: 55 where ``NAME`` is one of the following:
53 56
54 regexp:: 57 ``regexp``
55 Regular expression, Python/Perl syntax. 58 Regular expression, Python/Perl syntax.
56 glob:: 59 ``glob``
57 Shell-style glob. 60 Shell-style glob.
58 61
59 The chosen syntax stays in effect when parsing all patterns that 62 The chosen syntax stays in effect when parsing all patterns that
60 follow, until another syntax is selected. 63 follow, until another syntax is selected.
61 64
62 Neither glob nor regexp patterns are rooted. A glob-syntax pattern of 65 Neither glob nor regexp patterns are rooted. A glob-syntax pattern of
63 the form "`*.c`" will match a file ending in "`.c`" in any directory, 66 the form "``*.c``" will match a file ending in "``.c``" in any directory,
64 and a regexp pattern of the form "`\.c$`" will do the same. To root a 67 and a regexp pattern of the form "``\.c$``" will do the same. To root a
65 regexp pattern, start it with "`^`". 68 regexp pattern, start it with "``^``".
66 69
67 EXAMPLE 70 EXAMPLE
68 ------- 71 -------
69 72
70 Here is an example ignore file. 73 Here is an example ignore file. ::
71 74
72 # use glob syntax. 75 # use glob syntax.
73 syntax: glob 76 syntax: glob
74 77
75 *.elc 78 *.elc