##// END OF EJS Templates
help: document bundle specifications...
help: document bundle specifications I softly formalized the concept of a "bundle specification" a while ago when I was working on clone bundles and stream clone bundles and wanted a more robust way to define what exactly is in a bundle file. The concept has existed for a while. Since it is part of the clone bundles feature and exposed to the user via the "-t" argument to `hg bundle`, it is something we need to support for the long haul. After the 4.1 release, I heard a few people comment that they didn't realize you could generate zstd bundles with `hg bundle`. I'm partially to blame for not documenting it in bundle's docstring. Additionally, I added a hacky, experimental feature for controlling the compression level of bundles in 76104a4899ad. As the commit message says, I went with a quick and dirty solution out of time constraints. Furthermore, I wanted to eventually store this configuration in the "bundlespec" so it could be made more flexible. Given: a) bundlespecs are here to stay b) we don't have great documentation over what they are, despite being a user-facing feature c) the list of available compression engines and their behavior isn't exposed d) we need an extensible place to modify behavior of compression engines I want to move forward with formalizing bundlespecs as a user-facing feature. This commit does that by introducing a "bundlespec" help page. Leaning on the just-added compression engine documentation and API, the topic also conveniently lists available compression engines and details about them. This makes features like zstd bundle compression more discoverable. e.g. you can now `hg help -k zstd` and it lists the "bundlespec" topic.

File last commit:

r30731:b8a188a6 default
r31793:69d8fcf2 default
Show More
templates.txt
192 lines | 5.0 KiB | text/plain | TextLexer
Mercurial allows you to customize output of commands through
templates. You can either pass in a template or select an existing
template-style from the command line, via the --template option.
You can customize output for any "log-like" command: log,
outgoing, incoming, tip, parents, and heads.
Some built-in styles are packaged with Mercurial. These can be listed
with :hg:`log --template list`. Example usage::
$ hg log -r1.0::1.1 --template changelog
A template is a piece of text, with markup to invoke variable
expansion::
$ hg log -r1 --template "{node}\n"
b56ce7b07c52de7d5fd79fb89701ea538af65746
Keywords
========
Strings in curly braces are called keywords. The availability of
keywords depends on the exact context of the templater. These
keywords are usually available for templating a log-like command:
.. keywordsmarker
The "date" keyword does not produce human-readable output. If you
want to use a date in your output, you can use a filter to process
it. Filters are functions which return a string based on the input
variable. Be sure to use the stringify filter first when you're
applying a string-input filter to a list-like input variable.
You can also use a chain of filters to get the desired output::
$ hg tip --template "{date|isodate}\n"
2008-08-21 18:22 +0000
Filters
=======
List of filters:
.. filtersmarker
Note that a filter is nothing more than a function call, i.e.
``expr|filter`` is equivalent to ``filter(expr)``.
Functions
=========
In addition to filters, there are some basic built-in functions:
.. functionsmarker
Operators
=========
We provide a limited set of infix arithmetic operations on integers::
+ for addition
- for subtraction
* for multiplication
/ for floor division (division rounded to integer nearest -infinity)
Division fulfils the law x = x / y + mod(x, y).
Also, for any expression that returns a list, there is a list operator::
expr % "{template}"
As seen in the above example, ``{template}`` is interpreted as a template.
To prevent it from being interpreted, you can use an escape character ``\{``
or a raw string prefix, ``r'...'``.
Aliases
=======
New keywords and functions can be defined in the ``templatealias`` section of
a Mercurial configuration file::
<alias> = <definition>
Arguments of the form `a1`, `a2`, etc. are substituted from the alias into
the definition.
For example,
::
[templatealias]
r = rev
rn = "{r}:{node|short}"
leftpad(s, w) = pad(s, w, ' ', True)
defines two symbol aliases, ``r`` and ``rn``, and a function alias
``leftpad()``.
It's also possible to specify complete template strings, using the
``templates`` section. The syntax used is the general template string syntax.
For example,
::
[templates]
nodedate = "{node|short}: {date(date, "%Y-%m-%d")}\n"
defines a template, ``nodedate``, which can be called like::
$ hg log -r . -Tnodedate
Examples
========
Some sample command line templates:
- Format lists, e.g. files::
$ hg log -r 0 --template "files:\n{files % ' {file}\n'}"
- Join the list of files with a ", "::
$ hg log -r 0 --template "files: {join(files, ', ')}\n"
- Join the list of files ending with ".py" with a ", "::
$ hg log -r 0 --template "pythonfiles: {join(files('**.py'), ', ')}\n"
- Separate non-empty arguments by a " "::
$ hg log -r 0 --template "{separate(' ', node, bookmarks, tags}\n"
- Modify each line of a commit description::
$ hg log --template "{splitlines(desc) % '**** {line}\n'}"
- Format date::
$ hg log -r 0 --template "{date(date, '%Y')}\n"
- Display date in UTC::
$ hg log -r 0 --template "{localdate(date, 'UTC')|date}\n"
- Output the description set to a fill-width of 30::
$ hg log -r 0 --template "{fill(desc, 30)}"
- Use a conditional to test for the default branch::
$ hg log -r 0 --template "{ifeq(branch, 'default', 'on the main branch',
'on branch {branch}')}\n"
- Append a newline if not empty::
$ hg tip --template "{if(author, '{author}\n')}"
- Label the output for use with the color extension::
$ hg log -r 0 --template "{label('changeset.{phase}', node|short)}\n"
- Invert the firstline filter, i.e. everything but the first line::
$ hg log -r 0 --template "{sub(r'^.*\n?\n?', '', desc)}\n"
- Display the contents of the 'extra' field, one per line::
$ hg log -r 0 --template "{join(extras, '\n')}\n"
- Mark the active bookmark with '*'::
$ hg log --template "{bookmarks % '{bookmark}{ifeq(bookmark, active, '*')} '}\n"
- Find the previous release candidate tag, the distance and changes since the tag::
$ hg log -r . --template "{latesttag('re:^.*-rc$') % '{tag}, {changes}, {distance}'}\n"
- Mark the working copy parent with '@'::
$ hg log --template "{ifcontains(rev, revset('.'), '@')}\n"
- Show details of parent revisions::
$ hg log --template "{revset('parents(%d)', rev) % '{desc|firstline}\n'}"
- Show only commit descriptions that start with "template"::
$ hg log --template "{startswith('template', firstline(desc))}\n"
- Print the first word of each line of a commit message::
$ hg log --template "{word(0, desc)}\n"