[PATCH RESEND] keyword: update documentation for kwshrink

Christian Ebert blacktrash at gmx.net
Sun Jan 16 08:47:57 CST 2011


# HG changeset patch
# User Christian Ebert <blacktrash at gmx.net>
# Date 1295189126 -3600
# Node ID 241983968ad4f7388c8501143cf28aaaa035857a
# Parent  fff12b3d953a39ed70ae092b5a0f41daa0c7c34d
keyword: update documentation for kwshrink

* remove obsolete reference to potential problems with merge and import
* emphasize that running kwshrink before configuration changes which
  affect active/expanded keywords is mandatory

diff --git a/hgext/keyword.py b/hgext/keyword.py
--- a/hgext/keyword.py
+++ b/hgext/keyword.py
@@ -70,9 +70,8 @@
 replaced with customized keywords and templates. Again, run
 :hg:`kwdemo` to control the results of your configuration changes.
 
-Before changing/disabling active keywords, run :hg:`kwshrink` to avoid
-the risk of inadvertently storing expanded keywords in the change
-history.
+Before changing/disabling active keywords, you must run :hg:`kwshrink`
+to avoid storing expanded keywords in the change history.
 
 To force expansion after enabling it, or a configuration change, run
 :hg:`kwexpand`.
@@ -465,8 +464,7 @@
 def shrink(ui, repo, *pats, **opts):
     '''revert expanded keywords in the working directory
 
-    Run before changing/disabling active keywords or if you experience
-    problems with :hg:`import` or :hg:`merge`.
+    Must be run before changing/disabling active keywords.
 
     kwshrink refuses to run if given files contain local changes.
     '''


More information about the Mercurial-devel mailing list