##// END OF EJS Templates
help: update template examples to use reST literal syntax...
Yuya Nishihara -
r28040:6db47740 stable
parent child Browse files
Show More
@@ -1,123 +1,123 b''
1 Mercurial allows you to customize output of commands through
1 Mercurial allows you to customize output of commands through
2 templates. You can either pass in a template or select an existing
2 templates. You can either pass in a template or select an existing
3 template-style from the command line, via the --template option.
3 template-style from the command line, via the --template option.
4
4
5 You can customize output for any "log-like" command: log,
5 You can customize output for any "log-like" command: log,
6 outgoing, incoming, tip, parents, and heads.
6 outgoing, incoming, tip, parents, and heads.
7
7
8 Some built-in styles are packaged with Mercurial. These can be listed
8 Some built-in styles are packaged with Mercurial. These can be listed
9 with :hg:`log --template list`. Example usage::
9 with :hg:`log --template list`. Example usage::
10
10
11 $ hg log -r1.0::1.1 --template changelog
11 $ hg log -r1.0::1.1 --template changelog
12
12
13 A template is a piece of text, with markup to invoke variable
13 A template is a piece of text, with markup to invoke variable
14 expansion::
14 expansion::
15
15
16 $ hg log -r1 --template "{node}\n"
16 $ hg log -r1 --template "{node}\n"
17 b56ce7b07c52de7d5fd79fb89701ea538af65746
17 b56ce7b07c52de7d5fd79fb89701ea538af65746
18
18
19 Strings in curly braces are called keywords. The availability of
19 Strings in curly braces are called keywords. The availability of
20 keywords depends on the exact context of the templater. These
20 keywords depends on the exact context of the templater. These
21 keywords are usually available for templating a log-like command:
21 keywords are usually available for templating a log-like command:
22
22
23 .. keywordsmarker
23 .. keywordsmarker
24
24
25 The "date" keyword does not produce human-readable output. If you
25 The "date" keyword does not produce human-readable output. If you
26 want to use a date in your output, you can use a filter to process
26 want to use a date in your output, you can use a filter to process
27 it. Filters are functions which return a string based on the input
27 it. Filters are functions which return a string based on the input
28 variable. Be sure to use the stringify filter first when you're
28 variable. Be sure to use the stringify filter first when you're
29 applying a string-input filter to a list-like input variable.
29 applying a string-input filter to a list-like input variable.
30 You can also use a chain of filters to get the desired output::
30 You can also use a chain of filters to get the desired output::
31
31
32 $ hg tip --template "{date|isodate}\n"
32 $ hg tip --template "{date|isodate}\n"
33 2008-08-21 18:22 +0000
33 2008-08-21 18:22 +0000
34
34
35 List of filters:
35 List of filters:
36
36
37 .. filtersmarker
37 .. filtersmarker
38
38
39 Note that a filter is nothing more than a function call, i.e.
39 Note that a filter is nothing more than a function call, i.e.
40 ``expr|filter`` is equivalent to ``filter(expr)``.
40 ``expr|filter`` is equivalent to ``filter(expr)``.
41
41
42 In addition to filters, there are some basic built-in functions:
42 In addition to filters, there are some basic built-in functions:
43
43
44 .. functionsmarker
44 .. functionsmarker
45
45
46 Also, for any expression that returns a list, there is a list operator:
46 Also, for any expression that returns a list, there is a list operator::
47
47
48 - expr % "{template}"
48 expr % "{template}"
49
49
50 As seen in the above example, "{template}" is interpreted as a template.
50 As seen in the above example, ``{template}`` is interpreted as a template.
51 To prevent it from being interpreted, you can use an escape character "\{"
51 To prevent it from being interpreted, you can use an escape character ``\{``
52 or a raw string prefix, "r'...'".
52 or a raw string prefix, ``r'...'``.
53
53
54 Some sample command line templates:
54 Some sample command line templates:
55
55
56 - Format lists, e.g. files::
56 - Format lists, e.g. files::
57
57
58 $ hg log -r 0 --template "files:\n{files % ' {file}\n'}"
58 $ hg log -r 0 --template "files:\n{files % ' {file}\n'}"
59
59
60 - Join the list of files with a ", "::
60 - Join the list of files with a ", "::
61
61
62 $ hg log -r 0 --template "files: {join(files, ', ')}\n"
62 $ hg log -r 0 --template "files: {join(files, ', ')}\n"
63
63
64 - Modify each line of a commit description::
64 - Modify each line of a commit description::
65
65
66 $ hg log --template "{splitlines(desc) % '**** {line}\n'}"
66 $ hg log --template "{splitlines(desc) % '**** {line}\n'}"
67
67
68 - Format date::
68 - Format date::
69
69
70 $ hg log -r 0 --template "{date(date, '%Y')}\n"
70 $ hg log -r 0 --template "{date(date, '%Y')}\n"
71
71
72 - Display date in UTC::
72 - Display date in UTC::
73
73
74 $ hg log -r 0 --template "{localdate(date, 'UTC')|date}\n"
74 $ hg log -r 0 --template "{localdate(date, 'UTC')|date}\n"
75
75
76 - Output the description set to a fill-width of 30::
76 - Output the description set to a fill-width of 30::
77
77
78 $ hg log -r 0 --template "{fill(desc, 30)}"
78 $ hg log -r 0 --template "{fill(desc, 30)}"
79
79
80 - Use a conditional to test for the default branch::
80 - Use a conditional to test for the default branch::
81
81
82 $ hg log -r 0 --template "{ifeq(branch, 'default', 'on the main branch',
82 $ hg log -r 0 --template "{ifeq(branch, 'default', 'on the main branch',
83 'on branch {branch}')}\n"
83 'on branch {branch}')}\n"
84
84
85 - Append a newline if not empty::
85 - Append a newline if not empty::
86
86
87 $ hg tip --template "{if(author, '{author}\n')}"
87 $ hg tip --template "{if(author, '{author}\n')}"
88
88
89 - Label the output for use with the color extension::
89 - Label the output for use with the color extension::
90
90
91 $ hg log -r 0 --template "{label('changeset.{phase}', node|short)}\n"
91 $ hg log -r 0 --template "{label('changeset.{phase}', node|short)}\n"
92
92
93 - Invert the firstline filter, i.e. everything but the first line::
93 - Invert the firstline filter, i.e. everything but the first line::
94
94
95 $ hg log -r 0 --template "{sub(r'^.*\n?\n?', '', desc)}\n"
95 $ hg log -r 0 --template "{sub(r'^.*\n?\n?', '', desc)}\n"
96
96
97 - Display the contents of the 'extra' field, one per line::
97 - Display the contents of the 'extra' field, one per line::
98
98
99 $ hg log -r 0 --template "{join(extras, '\n')}\n"
99 $ hg log -r 0 --template "{join(extras, '\n')}\n"
100
100
101 - Mark the active bookmark with '*'::
101 - Mark the active bookmark with '*'::
102
102
103 $ hg log --template "{bookmarks % '{bookmark}{ifeq(bookmark, active, '*')} '}\n"
103 $ hg log --template "{bookmarks % '{bookmark}{ifeq(bookmark, active, '*')} '}\n"
104
104
105 - Find the previous release candidate tag, the distance and changes since the tag::
105 - Find the previous release candidate tag, the distance and changes since the tag::
106
106
107 $ hg log -r . --template "{latesttag('re:^.*-rc$') % '{tag}, {changes}, {distance}'}\n"
107 $ hg log -r . --template "{latesttag('re:^.*-rc$') % '{tag}, {changes}, {distance}'}\n"
108
108
109 - Mark the working copy parent with '@'::
109 - Mark the working copy parent with '@'::
110
110
111 $ hg log --template "{ifcontains(rev, revset('.'), '@')}\n"
111 $ hg log --template "{ifcontains(rev, revset('.'), '@')}\n"
112
112
113 - Show details of parent revisions::
113 - Show details of parent revisions::
114
114
115 $ hg log --template "{revset('parents(%d)', rev) % '{desc|firstline}\n'}"
115 $ hg log --template "{revset('parents(%d)', rev) % '{desc|firstline}\n'}"
116
116
117 - Show only commit descriptions that start with "template"::
117 - Show only commit descriptions that start with "template"::
118
118
119 $ hg log --template "{startswith('template', firstline(desc))}\n"
119 $ hg log --template "{startswith('template', firstline(desc))}\n"
120
120
121 - Print the first word of each line of a commit message::
121 - Print the first word of each line of a commit message::
122
122
123 $ hg log --template "{word(0, desc)}\n"
123 $ hg log --template "{word(0, desc)}\n"
General Comments 0
You need to be logged in to leave comments. Login now