annotate mercurial/help/filesets.txt @ 26755:bb0b955d050d

streamclone: support for producing and consuming stream clone bundles

Up to this point, stream clones only existed as a dynamically generated
data format produced and consumed during streaming clones. In order to
support this efficient cloning format with the clone bundles feature, we
need a more formal, on disk representation of the streaming clone data.

This patch introduces a new "bundle" type for streaming clones. Unlike
existing bundles, it does not contain changegroup data. It does,
however, share the same concepts like the 4 byte header which identifies
the type of data that follows and the 2 byte abbreviation for
compression types (of which only "UN" is currently supported).

The new bundle format is essentially the existing stream clone version 1
data format with some headers at the beginning.

Content negotiation at stream clone request time checked for repository
format/requirements compatibility before initiating a stream clone. We
can't do active content negotiation when using clone bundles. So, we put
this set of requirements inside the payload so consumers have a built-in
mechanism for checking compatibility before reading and applying lots of
data. Of course, we will also advertise this requirements set in clone
bundles. But that's for another patch.

We currently don't have a mechanism to produce and consume this new
bundle format. This will be implemented in upcoming patches.

It's worth noting that if a legacy client attempts to `hg unbundle` a
stream clone bundle (with the "HGS1" header), it will abort with:
"unknown bundle version S1," which seems appropriate.

Mercurial supports a functional language for selecting a set of
files.

Like other file patterns, this pattern type is indicated by a prefix,
'set:'. The language supports a number of predicates which are joined
by infix operators. Parenthesis can be used for grouping.

Identifiers such as filenames or patterns must be quoted with single
or double quotes if they contain characters outside of
``[.*{}[]?/\_a-zA-Z0-9\x80-\xff]`` or if they match one of the
predefined predicates. This generally applies to file patterns other
than globs and arguments for predicates.

Special characters can be used in quoted identifiers by escaping them,
e.g., ``\n`` is interpreted as a newline. To prevent them from being
interpreted, strings can be prefixed with ``r``, e.g. ``r'...'``.

There is a single prefix operator:

``not x``
  Files not in x. Short form is ``! x``.

These are the supported infix operators:

``x and y``
  The intersection of files in x and y. Short form is ``x & y``.

``x or y``
  The union of files in x and y. There are two alternative short
  forms: ``x | y`` and ``x + y``.

``x - y``
  Files in x but not in y.

The following predicates are supported:

.. predicatesmarker

Some sample queries:

- Show status of files that appear to be binary in the working directory::

    hg status -A "set:binary()"

- Forget files that are in .hgignore but are already tracked::

    hg forget "set:hgignore() and not ignored()"

- Find text files that contain a string::

    hg files "set:grep(magic) and not binary()"

- Find C files in a non-standard encoding::

    hg files "set:**.c and not encoding('UTF-8')"

- Revert copies of large binary files::

    hg revert "set:copied() and binary() and size('>1M')"

- Remove files listed in foo.lst that contain the letter a or b::

    hg remove "set: 'listfile:foo.lst' and (**a* or **b*)"

See also :hg:`help patterns`.