Document reposetup; recommend loading on per-repo basis kwmap-templates
authorChristian Ebert <blacktrash@gmx.net>
Wed, 17 Jan 2007 23:55:54 +0100
branchkwmap-templates
changeset 108 25dac950a1f0
parent 107 fe4a0495eca8
child 109 b2cc6a8d4a18
Document reposetup; recommend loading on per-repo basis
hgkw/keyword.py
--- a/hgkw/keyword.py	Tue Jan 16 19:17:54 2007 +0100
+++ b/hgkw/keyword.py	Wed Jan 17 23:55:54 2007 +0100
@@ -17,6 +17,9 @@
 You can either use the default cvs-like keywords or provide your
 own in hgrc.
 
+It is recommended to enable this extension on a per-repo basis only.
+You can still configure keywordmaps globally.
+
 Expansions spanning more than one line are truncated to their first line.
 Incremental expansion (like CVS' $Log$) is not supported.
 
@@ -112,6 +115,9 @@
 
 
 def reposetup(ui, repo):
+    '''Sets up repo, and filelog especially, as kwrepo and kwfilelog
+    for keyword substitution.  This is done for local repos only.'''
+
     from mercurial import context, filelog, revlog
     if not repo.local():
         return