# HG changeset patch
# User Christian Ebert <blacktrash@gmx.net>
# Date 1246100725 -7200
# Node ID be6b57b2bdb84889e993e38fd5bd419c94089f2c
# Parent  8d985f0e54aee73d1fec37300a199c25ea051896
keyword: improve help for kwfiles

diff -r 8d985f0e54ae -r be6b57b2bdb8 hgext/keyword.py
--- a/hgext/keyword.py	Sat Jun 27 13:08:07 2009 +0200
+++ b/hgext/keyword.py	Sat Jun 27 13:05:25 2009 +0200
@@ -359,11 +359,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)
diff -r 8d985f0e54ae -r be6b57b2bdb8 tests/test-keyword.out
--- a/tests/test-keyword.out	Sat Jun 27 13:08:07 2009 +0200
+++ b/tests/test-keyword.out	Sat Jun 27 13:05:25 2009 +0200
@@ -50,7 +50,7 @@
 
  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
 
 enabled extensions: