(0.9.2compat) improve help for kwfiles 0.9.2compat
authorChristian Ebert <blacktrash@gmx.net>
Sat, 27 Jun 2009 15:58:46 +0200
branch0.9.2compat
changeset 594 748c766e6424
parent 589 3cad5778d217
child 598 2b1565ab7db3
(0.9.2compat) improve help for kwfiles
hgkw/keyword.py
tests/test-keyword.out
--- a/hgkw/keyword.py	Wed Jun 24 14:29:48 2009 +0200
+++ b/hgkw/keyword.py	Sat Jun 27 15:58:46 2009 +0200
@@ -536,11 +536,16 @@
     _kwfwrite(ui, repo, True, *pats, **opts)
 
 def files(ui, repo, *pats, **opts):
-    '''print files currently configured for keyword expansion
+    '''print filenames configured for keyword expansion
+
+    Check which filenames in the working directory are matched by the
+    [keyword] configuration patterns.
 
-    Crosscheck which files in working directory are potential targets
-    for keyword expansion. That is, files matched by [keyword] config
-    patterns but not symlinks.
+    Useful to prevent inadvertent keyword expansion and to speed up
+    execution by including only filenames that are actual candidates
+    for expansion.
+
+    Use -u/--untracked to display untracked filenames as well.
     '''
     kwt = kwtools['templater']
     status = _status(ui, repo, kwt, opts.get('untracked'), *pats, **opts)
--- a/tests/test-keyword.out	Wed Jun 24 14:29:48 2009 +0200
+++ b/tests/test-keyword.out	Sat Jun 27 15:58:46 2009 +0200
@@ -38,7 +38,7 @@
         Or, better, use bundle/unbundle to share changes.
  kwdemo     print [keywordmaps] configuration and an expansion example
  kwexpand   expand keywords in the working directory
- kwfiles    print files currently configured for keyword expansion
+ kwfiles    print filenames configured for keyword expansion
  kwshrink   revert expanded keywords in the working directory
 % hg kwdemo
 [extensions]