interhg: upgrade comments to online help and improve them
authorCédric Duval <cedricduval@free.fr>
Thu, 18 Jun 2009 08:18:52 +0200
changeset 8824 67ee7587abea
parent 8823 d9f4c182aeca
child 8825 ec33cf8610a9
interhg: upgrade comments to online help and improve them Some inspiration taken from the wiki page of the extension.
hgext/interhg.py
--- a/hgext/interhg.py	Tue Jun 16 22:24:46 2009 +0200
+++ b/hgext/interhg.py	Thu Jun 18 08:18:52 2009 +0200
@@ -7,23 +7,25 @@
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
-#
-# The `interhg' Mercurial extension allows you to change changelog and
-# summary text just like InterWiki way.
-#
-# To enable this extension:
-#
-#   [extensions]
-#   interhg =
-#
-# These are some example patterns (link to bug tracking, etc.)
-#
-#   [interhg]
-#   issues = s!issue(\d+)!<a href="http://bts/issue\1">issue\1<\/a>!
-#   bugzilla = s!((?:bug|b=|(?=#?\d{4,}))(?:\s*#?)(\d+))!<a..=\2">\1</a>!i
-#   boldify = s/(^|\s)#(\d+)\b/ <b>#\2<\/b>/
-#
-# Add any number of names and patterns to match
+
+'''expand expressions into changelog and summaries
+
+This extension allows the use of a special syntax in summaries,
+which will be automatically expanded into links or any other
+arbitrary expression, much like InterWiki does.
+
+To enable this extension, add the following lines to your hgrc:
+
+  [extensions]
+  interhg =
+
+A few example patterns (link to bug tracking, etc.):
+
+  [interhg]
+  issues = s!issue(\d+)!<a href="http://bts/issue\1">issue\1<\/a>!
+  bugzilla = s!((?:bug|b=|(?=#?\d{4,}))(?:\s*#?)(\d+))!<a..=\2">\1</a>!i
+  boldify = s/(^|\s)#(\d+)\b/ <b>#\2<\/b>/
+'''
 
 import re
 from mercurial.hgweb import hgweb_mod