Anonymous avatar Anonymous committed 318b500

Add usage info in docstring.

Comments (0)

Files changed (1)

 
     Mercurial extension to read commit message from changelog.
 
+    Usage: set the name of your changelog in hgrc::
+
+        [changelog]
+        filename = CHANGES
+
+    Then, committing without a given message or logfile will check if the
+    changelog is included in the commit. If it is, the commit message shown
+    in the editor will contain everything added to the changelog.
+
     :copyright: 2008 by Georg Brandl.
     :license: BSD.
 """
     log = '\n'.join(log)
     # strip bullet points and whitespace on the left
     log = log.lstrip('*- \t')
+    # always let the user edit the message
     opts['force_editor'] = True
     opts['message'] = log
     return orig_commit(ui, repo, *pats, **opts)
 
 def uisetup(ui):
     if not hasattr(extensions, 'wrapcommand'):
-        return
+        return # doesn't work as nicely on old hg versions
     extensions.wrapcommand(commands.table, 'commit', new_commit)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.