Mercurial > hg
view mercurial/help/patterns.txt @ 35616:706aa203b396
fileset: add a lightweight file filtering language
This patch was inspired by one that Jun Wu authored for the fb-experimental
repo, to avoid using matcher for efficiency[1]. We want a way to specify what
files will be converted to LFS at commit time. And per discussion, we also want
to specify what files to skip, text diff, or merge in another config option.
The current `lfs.threshold` config option could not satisfy complex needs. I'm
putting it in a core package because Augie floated the idea of also using it for
narrow and sparse.
Yuya suggested farming out to fileset.parse(), which added support for more
symbols. The only fileset element not supported here is 'negate'. (List isn't
supported by filesets either.) I also changed the 'always' token to the 'all()'
predicate for consistency, and introduced 'none()' to improve readability in a
future tracked file based config. The extension operator was changed from '.'
to '**', to match how recursive path globs are specified. Finally, I changed
the path matcher from '/' to 'path:' at Yuya's suggestion, for consistency with
matcher. Unfortunately, ':' is currently reserved in filesets, so this has to
be quoted to be processed as a string instead of a symbol[2]. We should
probably revisit that, because it's seriously ugly. But it's only used by an
experimental extension, and I think using a file based config for LFS may drive
some more tweaks, so I'm settling for this for now.
I reserved all of the glob characters in fileset except '.' and '_' for the
extension test because those are likely valid extension characters.
Sample filter settings:
all() # everything
size(">20MB") # larger than 20MB
!**.txt # except for .txt files
**.zip | **.tar.gz | **.7z # some types of compressed files
"path:bin" # files under "bin" in the project root
[1] https://www.mercurial-scm.org/pipermail/mercurial-devel/2017-December/109387.html
[2] https://www.mercurial-scm.org/pipermail/mercurial-devel/2018-January/109729.html
author | Matt Harbison <matt_harbison@yahoo.com> |
---|---|
date | Wed, 10 Jan 2018 22:23:34 -0500 |
parents | efebc9f52ecb |
children | 4fab8a7d2d72 |
line wrap: on
line source
Mercurial accepts several notations for identifying one or more files at a time. By default, Mercurial treats filenames as shell-style extended glob patterns. Alternate pattern notations must be specified explicitly. .. note:: Patterns specified in ``.hgignore`` are not rooted. Please see :hg:`help hgignore` for details. To use a plain path name without any pattern matching, start it with ``path:``. These path names must completely match starting at the current repository root, and when the path points to a directory, it is matched recursively. To match all files in a directory non-recursively (not including any files in subdirectories), ``rootfilesin:`` can be used, specifying an absolute path (relative to the repository root). To use an extended glob, start a name with ``glob:``. Globs are rooted at the current directory; a glob such as ``*.c`` will only match files in the current directory ending with ``.c``. The supported glob syntax extensions are ``**`` to match any string across path separators and ``{a,b}`` to mean "a or b". To use a Perl/Python regular expression, start a name with ``re:``. Regexp pattern matching is anchored at the root of the repository. To read name patterns from a file, use ``listfile:`` or ``listfile0:``. The latter expects null delimited patterns while the former expects line feeds. Each string read from the file is itself treated as a file pattern. To read a set of patterns from a file, use ``include:`` or ``subinclude:``. ``include:`` will use all the patterns from the given file and treat them as if they had been passed in manually. ``subinclude:`` will only apply the patterns against files that are under the subinclude file's directory. See :hg:`help hgignore` for details on the format of these files. All patterns, except for ``glob:`` specified in command line (not for ``-I`` or ``-X`` options), can match also against directories: files under matched directories are treated as matched. For ``-I`` and ``-X`` options, ``glob:`` will match directories recursively. Plain examples:: path:foo/bar a name bar in a directory named foo in the root of the repository path:path:name a file or directory named "path:name" rootfilesin:foo/bar the files in a directory called foo/bar, but not any files in its subdirectories and not a file bar in directory foo Glob examples:: glob:*.c any name ending in ".c" in the current directory *.c any name ending in ".c" in the current directory **.c any name ending in ".c" in any subdirectory of the current directory including itself. foo/* any file in directory foo foo/** any file in directory foo plus all its subdirectories, recursively foo/*.c any name ending in ".c" in the directory foo foo/**.c any name ending in ".c" in any subdirectory of foo including itself. Regexp examples:: re:.*\.c$ any name ending in ".c", anywhere in the repository File examples:: listfile:list.txt read list from list.txt with one file pattern per line listfile0:list.txt read list from list.txt with null byte delimiters See also :hg:`help filesets`. Include examples:: include:path/to/mypatternfile reads patterns to be applied to all paths subinclude:path/to/subignorefile reads patterns specifically for paths in the subdirectory