changeset 120:9ed197b60e99

Prepare a [keywords] section with a whitelist of considered keywords and/or aliases
author Franz Glasner <hg@dom66.de>
date Fri, 17 Aug 2018 01:56:12 +0200
parents 65a2e6fc8442
children fbd332184240
files .hgkwarchive extensions/kwarchive.py
diffstat 2 files changed, 24 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/.hgkwarchive	Fri Aug 17 00:46:12 2018 +0200
+++ b/.hgkwarchive	Fri Aug 17 01:56:12 2018 +0200
@@ -2,3 +2,12 @@
 extensions/**.py =
 path:VERSION = reST
 path:README = RCS, reST
+
+[keywords]
+JustDate =
+HGheader =
+HGnodeid =
+Date =
+Revision =
+
+MyFullRevision = HGrevision
--- a/extensions/kwarchive.py	Fri Aug 17 00:46:12 2018 +0200
+++ b/extensions/kwarchive.py	Fri Aug 17 01:56:12 2018 +0200
@@ -17,6 +17,10 @@
 
 Example::
 
+   #
+   # Determine which files are consideres for keyword expansion in
+   # which style
+   #
    [patterns]
     #
     # expand keywords in every python file except those matching "x*"
@@ -28,6 +32,17 @@
     # this file has reStructuredText style and RCS style keyword expansion
     path:README = reST, RCS
 
+    #
+    # Determine which keywords are expanded.
+    # A missing and/or empty section means that all predefined keywords
+    # are expanded.
+    #
+    [keywords]
+    # $Revision$ and possibly the |VCSRevision| keyword is expanded
+    Revision =
+    # $MyKeyword$ is expanded with the contents of
+    MyKeyword =
+
 A non-existing ``.hgkwarchive`` file deactivates keyword expansion as does
 an empty ``[patterns]`` section.