# HG changeset patch
# User Christian Ebert <blacktrash@gmx.net>
# Date 1169074554 -3600
# Node ID 25dac950a1f051551a8e9b8d79b84df2166e3e28
# Parent  fe4a0495eca8f5431acf373082f37a3b11d00c95
Document reposetup; recommend loading on per-repo basis

diff -r fe4a0495eca8 -r 25dac950a1f0 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