changeset 3083:ad6aecaf4eed

document changelog format
author Benoit Boissinot <benoit.boissinot@ens-lyon.org>
date Sat, 09 Sep 2006 12:56:08 +0200
parents 1a792e4a1f3a
children baa3873eb387
files mercurial/changelog.py
diffstat 1 files changed, 8 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/changelog.py	Sat Sep 09 12:51:05 2006 +0200
+++ b/mercurial/changelog.py	Sat Sep 09 12:56:08 2006 +0200
@@ -16,6 +16,14 @@
                         defversion)
 
     def extract(self, text):
+        """
+        format used:
+        nodeid\n  : manifest node in ascii
+        user\n    : user, no \n or \r allowed
+        time tz\n : date (time is int or float, timezone is int)
+        files\n\n : files modified by the cset, no \n or \r allowed
+        (.*)      : comment (free text, ideally utf-8)
+        """
         if not text:
             return (nullid, "", (0, 0), [], "")
         last = text.index("\n\n")