##// END OF EJS Templates
keyword: wrapped docstrings at 78 characters
Martin Geisler -
r9066:11b111e9 default
parent child Browse files
Show More
@@ -28,15 +28,15 b''
28
28
29 '''expand keywords in tracked files
29 '''expand keywords in tracked files
30
30
31 This extension expands RCS/CVS-like or self-customized $Keywords$ in
31 This extension expands RCS/CVS-like or self-customized $Keywords$ in tracked
32 tracked text files selected by your configuration.
32 text files selected by your configuration.
33
33
34 Keywords are only expanded in local repositories and not stored in the
34 Keywords are only expanded in local repositories and not stored in the change
35 change history. The mechanism can be regarded as a convenience for the
35 history. The mechanism can be regarded as a convenience for the current user
36 current user or for archive distribution.
36 or for archive distribution.
37
37
38 Configuration is done in the [keyword] and [keywordmaps] sections of
38 Configuration is done in the [keyword] and [keywordmaps] sections of hgrc
39 hgrc files.
39 files.
40
40
41 Example:
41 Example:
42
42
@@ -45,33 +45,32 b' Example:'
45 **.py =
45 **.py =
46 x* = ignore
46 x* = ignore
47
47
48 Note: the more specific you are in your filename patterns
48 Note: the more specific you are in your filename patterns the less you lose
49 the less you lose speed in huge repositories.
49 speed in huge repositories.
50
50
51 For [keywordmaps] template mapping and expansion demonstration and
51 For [keywordmaps] template mapping and expansion demonstration and control run
52 control run "hg kwdemo".
52 "hg kwdemo".
53
53
54 An additional date template filter {date|utcdate} is provided.
54 An additional date template filter {date|utcdate} is provided.
55
55
56 The default template mappings (view with "hg kwdemo -d") can be
56 The default template mappings (view with "hg kwdemo -d") can be replaced with
57 replaced with customized keywords and templates. Again, run "hg
57 customized keywords and templates. Again, run "hg kwdemo" to control the
58 kwdemo" to control the results of your config changes.
58 results of your config changes.
59
59
60 Before changing/disabling active keywords, run "hg kwshrink" to avoid
60 Before changing/disabling active keywords, run "hg kwshrink" to avoid the risk
61 the risk of inadvertently storing expanded keywords in the change
61 of inadvertently storing expanded keywords in the change history.
62 history.
63
62
64 To force expansion after enabling it, or a configuration change, run
63 To force expansion after enabling it, or a configuration change, run "hg
65 "hg kwexpand".
64 kwexpand".
66
65
67 Also, when committing with the record extension or using mq's qrecord,
66 Also, when committing with the record extension or using mq's qrecord, be
68 be aware that keywords cannot be updated. Again, run "hg kwexpand" on
67 aware that keywords cannot be updated. Again, run "hg kwexpand" on the files
69 the files in question to update keyword expansions after all changes
68 in question to update keyword expansions after all changes have been checked
70 have been checked in.
69 in.
71
70
72 Expansions spanning more than one line and incremental expansions,
71 Expansions spanning more than one line and incremental expansions, like CVS'
73 like CVS' $Log$, are not supported. A keyword template map
72 $Log$, are not supported. A keyword template map "Log = {desc}" expands to the
74 "Log = {desc}" expands to the first line of the changeset description.
73 first line of the changeset description.
75 '''
74 '''
76
75
77 from mercurial import commands, cmdutil, dispatch, filelog, revlog, extensions
76 from mercurial import commands, cmdutil, dispatch, filelog, revlog, extensions
@@ -362,20 +361,19 b' def expand(ui, repo, *pats, **opts):'
362 def files(ui, repo, *pats, **opts):
361 def files(ui, repo, *pats, **opts):
363 '''show files configured for keyword expansion
362 '''show files configured for keyword expansion
364
363
365 List which files in the working directory are matched by the
364 List which files in the working directory are matched by the [keyword]
366 [keyword] configuration patterns.
365 configuration patterns.
367
366
368 Useful to prevent inadvertent keyword expansion and to speed up
367 Useful to prevent inadvertent keyword expansion and to speed up execution
369 execution by including only files that are actual candidates
368 by including only files that are actual candidates for expansion.
370 for expansion.
371
369
372 See "hg help keyword" on how to construct patterns both for
370 See "hg help keyword" on how to construct patterns both for inclusion and
373 inclusion and exclusion of files.
371 exclusion of files.
374
372
375 Use -u/--untracked to list untracked files as well.
373 Use -u/--untracked to list untracked files as well.
376
374
377 With -a/--all and -v/--verbose the codes used to show the status
375 With -a/--all and -v/--verbose the codes used to show the status of files
378 of files are:
376 are:
379 K = keyword expansion candidate
377 K = keyword expansion candidate
380 k = keyword expansion candidate (untracked)
378 k = keyword expansion candidate (untracked)
381 I = ignored
379 I = ignored
@@ -1,15 +1,15 b''
1 % help
1 % help
2 keyword extension - expand keywords in tracked files
2 keyword extension - expand keywords in tracked files
3
3
4 This extension expands RCS/CVS-like or self-customized $Keywords$ in
4 This extension expands RCS/CVS-like or self-customized $Keywords$ in tracked
5 tracked text files selected by your configuration.
5 text files selected by your configuration.
6
6
7 Keywords are only expanded in local repositories and not stored in the
7 Keywords are only expanded in local repositories and not stored in the change
8 change history. The mechanism can be regarded as a convenience for the
8 history. The mechanism can be regarded as a convenience for the current user
9 current user or for archive distribution.
9 or for archive distribution.
10
10
11 Configuration is done in the [keyword] and [keywordmaps] sections of
11 Configuration is done in the [keyword] and [keywordmaps] sections of hgrc
12 hgrc files.
12 files.
13
13
14 Example:
14 Example:
15
15
@@ -18,33 +18,32 b' Example:'
18 **.py =
18 **.py =
19 x* = ignore
19 x* = ignore
20
20
21 Note: the more specific you are in your filename patterns
21 Note: the more specific you are in your filename patterns the less you lose
22 the less you lose speed in huge repositories.
22 speed in huge repositories.
23
23
24 For [keywordmaps] template mapping and expansion demonstration and
24 For [keywordmaps] template mapping and expansion demonstration and control run
25 control run "hg kwdemo".
25 "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
29 The default template mappings (view with "hg kwdemo -d") can be replaced with
30 replaced with customized keywords and templates. Again, run "hg
30 customized keywords and templates. Again, run "hg kwdemo" to control the
31 kwdemo" to control the results of your config changes.
31 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 the risk
34 the risk of inadvertently storing expanded keywords in the change
34 of inadvertently storing expanded keywords in the change history.
35 history.
36
35
37 To force expansion after enabling it, or a configuration change, run
36 To force expansion after enabling it, or a configuration change, run "hg
38 "hg kwexpand".
37 kwexpand".
39
38
40 Also, when committing with the record extension or using mq's qrecord,
39 Also, when committing with the record extension or using mq's qrecord, be
41 be aware that keywords cannot be updated. Again, run "hg kwexpand" on
40 aware that keywords cannot be updated. Again, run "hg kwexpand" on the files
42 the files in question to update keyword expansions after all changes
41 in question to update keyword expansions after all changes have been checked
43 have been checked in.
42 in.
44
43
45 Expansions spanning more than one line and incremental expansions,
44 Expansions spanning more than one line and incremental expansions, like CVS'
46 like CVS' $Log$, are not supported. A keyword template map
45 $Log$, are not supported. A keyword template map "Log = {desc}" expands to the
47 "Log = {desc}" expands to the first line of the changeset description.
46 first line of the changeset description.
48
47
49 list of commands:
48 list of commands:
50
49
General Comments 0
You need to be logged in to leave comments. Login now