1 % help |
1 % help |
2 keyword extension - keyword expansion in local repositories |
2 keyword extension - keyword expansion in local repositories |
3 |
3 |
4 This extension expands RCS/CVS-like or self-customized $Keywords$ |
4 This extension expands RCS/CVS-like or self-customized $Keywords$ in |
5 in tracked text files selected by your configuration. |
5 tracked text files selected by your configuration. |
6 |
6 |
7 Keywords are only expanded in local repositories and not stored in |
7 Keywords are only expanded in local repositories and not stored in the |
8 the change history. The mechanism can be regarded as a convenience |
8 change history. The mechanism can be regarded as a convenience for the |
9 for the current user or for archive distribution. |
9 current user or for archive distribution. |
10 |
10 |
11 Configuration is done in the [keyword] and [keywordmaps] sections |
11 Configuration is done in the [keyword] and [keywordmaps] sections of |
12 of hgrc files. |
12 hgrc files. |
13 |
13 |
14 Example: |
14 Example: |
15 |
15 |
16 [keyword] |
16 [keyword] |
17 # expand keywords in every python file except those matching "x*" |
17 # expand keywords in every python file except those matching "x*" |
24 For [keywordmaps] template mapping and expansion demonstration and |
24 For [keywordmaps] template mapping and expansion demonstration and |
25 control run "hg kwdemo". |
25 control run "hg kwdemo". |
26 |
26 |
27 An additional date template filter {date|utcdate} is provided. |
27 An additional date template filter {date|utcdate} is provided. |
28 |
28 |
29 The default template mappings (view with "hg kwdemo -d") can be replaced |
29 The default template mappings (view with "hg kwdemo -d") can be |
30 with customized keywords and templates. |
30 replaced with customized keywords and templates. Again, run "hg |
31 Again, run "hg kwdemo" to control the results of your config changes. |
31 kwdemo" to control the results of your config changes. |
32 |
32 |
33 Before changing/disabling active keywords, run "hg kwshrink" to avoid |
33 Before changing/disabling active keywords, run "hg kwshrink" to avoid |
34 the risk of inadvertedly storing expanded keywords in the change history. |
34 the risk of inadvertedly storing expanded keywords in the change |
|
35 history. |
35 |
36 |
36 To force expansion after enabling it, or a configuration change, run |
37 To force expansion after enabling it, or a configuration change, run |
37 "hg kwexpand". |
38 "hg kwexpand". |
38 |
39 |
39 Also, when committing with the record extension or using mq's qrecord, be aware |
40 Also, when committing with the record extension or using mq's qrecord, |
40 that keywords cannot be updated. Again, run "hg kwexpand" on the files in |
41 be aware that keywords cannot be updated. Again, run "hg kwexpand" on |
41 question to update keyword expansions after all changes have been checked in. |
42 the files in question to update keyword expansions after all changes |
|
43 have been checked in. |
42 |
44 |
43 Expansions spanning more than one line and incremental expansions, |
45 Expansions spanning more than one line and incremental expansions, |
44 like CVS' $Log$, are not supported. A keyword template map |
46 like CVS' $Log$, are not supported. A keyword template map |
45 "Log = {desc}" expands to the first line of the changeset description. |
47 "Log = {desc}" expands to the first line of the changeset description. |
46 |
48 |