Updated docs

[zcommit.git] / zcommit.py

diff --git a/zcommit.py b/zcommit.py
index 6756e3e360c5abf42fb59b939f271f81034b89d0..6874ba81388bf2a84af12fca38f674ce87c11546 100755 (executable)
--- a/zcommit.py
+++ b/zcommit.py
@@ -35,7 +35,7 @@ msg: %(msg)s""" % {'sender' : sender,
                    'msg' : msg})
     cmd = [ZWRITE, '-S', sender, '-c', klass, '-i', instance,
            '-s', zsig, '-d', '-m', msg]
-    subprocess.check_call(cmd)
+    subprocess.check_call([str(p) for p in cmd])
 
 class Application(object):
     @cherrypy.expose
@@ -59,7 +59,9 @@ is parsed as having type <tt>github</tt>, class <tt>zcommit</tt>, and
 instance <tt>commit</tt>.  Using this information, zcommit figures out
 how to form a useful message which is then sends as a zephyr.
 
-<h1> Github </h1>
+<h1> Types </h1>
+
+<h2> Github </h2>
 
 Set your POST-back URL to
 <tt>http://zcommit.mit.edu/github/class/$classname</tt>, followed by
@@ -67,7 +69,7 @@ any of the following optional key/value parameters:
 
 <ul>
 <li> <tt>/instance/$instance</tt> </li>
-<li> <tt>/zsig/$zsig</tt> </li>
+<li> <tt>/zsig/$zsig</tt> (sets the prefix of the zsig; the postfix is always the branch name) </li>
 <li> <tt>/sender/$sender</tt> </li>
 </ul>
 """
@@ -113,14 +115,16 @@ any of the following optional key/value parameters:
                     if c.get('modified'):
                         actions.append('Modified: %s\n' % '\n  '.join(c['modified']))
                     if not actions:
-                        actions.append('Something weird happened... could not figure out what action to take')
+                        actions.append('Did not add/remove/modify any nonempty files.')
                     info = {'name' : c['author']['name'],
                             'email' : c['author']['email'],
                             'message' : c['message'],
                             'timestamp' : c['timestamp'],
-                            'actions' : '--\n'.join(actions)}
+                            'actions' : '--\n'.join(actions),
+                            'url' : c['url']}
                     
                     msg = """%(name)s <%(email)s> (%(timestamp)s)
+%(url)s
 > %(message)s
 --
 %(actions)s""" % info