From: Eric S. Raymond <esr@thyrsus.com>
Date: Fri, 14 Nov 2014 06:57:50 +0000 (-0500)
Subject: More documentation.  All regression tests pass.
X-Git-Tag: 0.8~3
X-Git-Url: http://thyrsus.com/gitweb/?a=commitdiff_plain;h=13a6ab2ae1fbee6a2d55664e401eb2290465b051;p=src.git

More documentation.  All regression tests pass.
---

diff --git a/TODO b/TODO
index 4ad78bc..176f213 100644
--- a/TODO
+++ b/TODO
@@ -5,6 +5,8 @@
 
 * should be possible to range-restict a tag or branch listing.
 
+* Discard "*** empty log message ***"
+
 * break up the tag and branch commands - separate delete/list/rename.
 
 * vc-src.el
diff --git a/src b/src
index b3c5baf..b626c1b 100755
--- a/src
+++ b/src
@@ -252,8 +252,9 @@ The following help topics are available:
 intro     -- Basic concepts: commits, tags, branches. The form of commands.
 revisions -- How to specify ranges of commits to operate on.
 commands  -- a summary of the commands.
-commit    -- how to commit changes to a file.
-status    -- details about the src status command.
+commit    -- the commit comand: how to commit changes to a file.
+amend     -- the amend commant: editing stored change comments.
+status    -- the status command: more details and unusual status codes
 ignores   -- .srcignore files and their uses.
 """,
     "intro": """
@@ -334,7 +335,7 @@ src commit [- | -m 'string' | -f 'file' | -e] ['file'...]
    following string as the comment; with '-f' take from a file.
    With '-e', edit even after '-f' or '-m'.  'ci' is a synonym for commit.
 
-src amend [- | -m string | -f file | -e] ['revision'] ['file'...]::
+src amend [- | -m string | -f file | -e] ['revision'] ['file'...]
    Amends the stored comment for a specified revision, defaulting to the
    latest revision on the current branch. Flags are as for commit.
 
@@ -468,6 +469,10 @@ SRC respects the EDITOR variable and calls it on a tempporary file
 to create your comment.  Th file will have a footer including its
 name and revision which will be discarded when you finish editing.
 
+If you leave the comment empty (except for the generated footer)
+or consisting only of whitespace, the commit will be aborted.  The
+commit will also be aborted if your editor returns a failure status.
+
 If you commit to multiple files at once, separate changes will be
 registered for each one, and you may get a separate edit session for
 each (if you have not set the comment text with options, or have
@@ -476,6 +481,20 @@ which are usually designed to create changesets common to multiple
 files.
 
 'ci' is a synonym for commit.
+""",
+    "amend" : """
+src amend [- | -m string | -f file | -e] ['revision'] ['file'...]
+
+Use this commant to amend (modify) the change comment in a savesed revision.
+The commit date is not changed.
+
+Takes a singleton revision number, tag, or branch, defaulting to the
+latest revision on the current branch.
+
+The edit flags and EDITOR variable are interpreted are as for commit.
+The only difference is that existing change comment is appended to
+any text you specify with switches as the initial conent ppassed
+to your editor.
 """,
     "ignores" : """
 You can have a file named .srcignore containing the names of files that