comparison mercurial/help/patterns.txt @ 25284:7072b91ccd20

help: add documentation on include: and subinclude: Adds some help text about the new include: and subinclude: match syntax.
author Durham Goode <durham@fb.com>
date Wed, 20 May 2015 14:54:09 -0700
parents f1a3ae7c15df
children 88358446da16
comparison
equal deleted inserted replaced
25283:19d0e5efa6ca 25284:7072b91ccd20
28 To read name patterns from a file, use ``listfile:`` or ``listfile0:``. 28 To read name patterns from a file, use ``listfile:`` or ``listfile0:``.
29 The latter expects null delimited patterns while the former expects line 29 The latter expects null delimited patterns while the former expects line
30 feeds. Each string read from the file is itself treated as a file 30 feeds. Each string read from the file is itself treated as a file
31 pattern. 31 pattern.
32 32
33 To read a set of patterns from a file, use ``include:`` or ``subinclude:``.
34 ``include:`` will use all the patterns from the given file and treat them as if
35 they had been passed in manually. ``subinclude:`` will only apply the patterns
36 against files that are under the subinclude file's directory. See :hg:`help
37 hgignore` for details on the format of these files.
38
33 All patterns, except for ``glob:`` specified in command line (not for 39 All patterns, except for ``glob:`` specified in command line (not for
34 ``-I`` or ``-X`` options), can match also against directories: files 40 ``-I`` or ``-X`` options), can match also against directories: files
35 under matched directories are treated as matched. 41 under matched directories are treated as matched.
36 42
37 Plain examples:: 43 Plain examples::
58 64
59 listfile:list.txt read list from list.txt with one file pattern per line 65 listfile:list.txt read list from list.txt with one file pattern per line
60 listfile0:list.txt read list from list.txt with null byte delimiters 66 listfile0:list.txt read list from list.txt with null byte delimiters
61 67
62 See also :hg:`help filesets`. 68 See also :hg:`help filesets`.
69
70 Include examples::
71
72 include:path/to/mypatternfile reads patterns to be applied to all paths
73 subinclude:path/to/subignorefile reads patterns specifically for paths in the
74 subdirectory