[PATCH] Make usage documentation for git-blame and git-annotate consistent.

[PATCH] Make usage documentation for git-blame and git-annotate consistent.

[Brian Hetro]

Added git-annotate usage in the synopsis.  The extended information in
the git-blame usage was removed, as no other builtin does this and it
just repeats what is in the full documentation.

Signed-off-by: Brian Hetro <whee@smaertness.net>
---
 Documentation/git-annotate.txt |    5 ++++-
 Documentation/git-blame.txt    |    6 +++---
 builtin-blame.c                |   17 +----------------
 3 files changed, 8 insertions(+), 20 deletions(-)

diff --git a/Documentation/git-annotate.txt b/Documentation/git-annotate.txt
index 02dc474..cd5faab 100644
--- a/Documentation/git-annotate.txt
+++ b/Documentation/git-annotate.txt
@@ -7,7 +7,10 @@ git-annotate - Annotate file lines with commit info
 
 SYNOPSIS
 --------
-git-annotate [options] file [revision]
+[verse]
+'git-annotate' [-b] [-l] [--root] [-t] [-p] [--incremental] [-L n,m]
+               [-S <revs-file>] [-M] [-C] [-C] [--since=<date>]
+               [<rev> | --contents <file>] [--] <file>
 
 DESCRIPTION
 -----------
diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt
index 66f1203..e8ddfea 100644
--- a/Documentation/git-blame.txt
+++ b/Documentation/git-blame.txt
@@ -8,9 +8,9 @@ git-blame - Show what revision and author last modified each line of a file
 SYNOPSIS
 --------
 [verse]
-'git-blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-p] [-w] [--incremental] [-L n,m]
-            [-S <revs-file>] [-M] [-C] [-C] [--since=<date>]
-            [<rev> | --contents <file>] [--] <file>
+'git-blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-p] [-w]
+            [--incremental] [-L n,m] [-S <revs-file>] [-M] [-C] [-C]
+            [--since=<date>] [<rev> | --contents <file>] [--] <file>
 
 DESCRIPTION
 -----------
diff --git a/builtin-blame.c b/builtin-blame.c
index 0519339..222eba5 100644
--- a/builtin-blame.c
+++ b/builtin-blame.c
@@ -20,22 +20,7 @@
 #include "mailmap.h"
 
 static char blame_usage[] =
-"git-blame [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-p] [-w] [-L n,m] [-S <revs-file>] [-M] [-C] [-C] [--contents <filename>] [--incremental] [commit] [--] file\n"
-"  -c                  Use the same output mode as git-annotate (Default: off)\n"
-"  -b                  Show blank SHA-1 for boundary commits (Default: off)\n"
-"  -l                  Show long commit SHA1 (Default: off)\n"
-"  --root              Do not treat root commits as boundaries (Default: off)\n"
-"  -t                  Show raw timestamp (Default: off)\n"
-"  -f, --show-name     Show original filename (Default: auto)\n"
-"  -n, --show-number   Show original linenumber (Default: off)\n"
-"  -s                  Suppress author name and timestamp (Default: off)\n"
-"  -p, --porcelain     Show in a format designed for machine consumption\n"
-"  -w                  Ignore whitespace differences\n"
-"  -L n,m              Process only line range n,m, counting from 1\n"
-"  -M, -C              Find line movements within and across files\n"
-"  --incremental       Show blame entries as we find them, incrementally\n"
-"  --contents file     Use <file>'s contents as the final image\n"
-"  -S revs-file        Use revisions from revs-file instead of calling git-rev-list\n";
+"git-blame [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-p] [-w] [--incremental] [-L n,m] [-S <revs-file>] [-M] [-C] [-C] [--since=<date>] [<rev> | --contents <file>] [--] <file>";
 
 static int longest_file;
 static int longest_author;
-- 
1.5.3.rc6.23.g0058-dirty

Re: [PATCH] Make usage documentation for git-blame and git-annotate consistent.

[Junio C Hamano]

Brian Hetro <whee@smaertness.net> writes:

> Added git-annotate usage in the synopsis.

I'd rather not do this.  The git-annotate wrapper is a
transitional measure for backward compatibility, and I do not
think we should advertise the options that are added in
git-blame there, even though the command option parser is lazy
and does not turn them off.  Ideally disabling non annotate
options would be a good thing to have if it were free, but I do
not think it is worth it.