Mercurial > hgrepos > DevTools > mercurial-extensions

changeset 129:51a4f1f5df09

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docu: enhanced the docu of "kwarchive"
author Franz Glasner <hg@dom66.de>
date Sat, 18 Aug 2018 18:30:18 +0200
parents 7482584331b4
children c3397e670063
files extensions/kwarchive.py
diffstat 1 files changed, 12 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/extensions/kwarchive.py	Fri Aug 17 09:28:51 2018 +0200
+++ b/extensions/kwarchive.py	Sat Aug 18 18:30:18 2018 +0200
@@ -4,16 +4,13 @@
 #
 """like :hg:`archive` but with keyword expansion within selected files
 
-The patterns of files to to expanded are configured in an versioned
-``.hgkwarchive`` configuration file found in the root of the working
-directory.
-
-The ``.hgkwarchive`` file uses the same syntax as all other Mercurial
+Configuration is done in a versioned ``.hgkwarchive`` configuration
+file. This file uses the same syntax as all other Mercurial
 configuration files.
 
-The ``[patterns]`` section specifies which files should have the keywords
-expanded.
-
+The ``[patterns]`` section specifies which files should have the
+keywords expanded and possibly the style of expansion. The keys are
+Mercurial file name patterns as described in :hg:`patterns`.
 
 Example::
 
@@ -33,6 +30,13 @@
     # This file has reStructuredText style and RCS style keyword expansion
     path:README = reST, RCS
 
+The ``[keyword]`` section specifies which keywords are expanded. Aliases
+can be defined also. By default the pre-defined set of RCC/CVS/SVN-like
+keywords is expanded. A non-empty ``[keyword]`` section defines an
+explicit white-list of expanded keywords and/or aliases.
+
+Example::
+
     #
     # Determine which keywords are expanded.
     # A missing and/or empty section means that all predefined keywords