[PATCH] Documentation changes to recursive option for git-diff-tree

[PATCH] Documentation changes to recursive option for git-diff-tree

[Chris Shoemaker]

Subject: [PATCH] Documentation changes to recursive option for git-diff-tree

    Update docs and usages regarding '-r' recursive option for git-diff-tree.
    Remove '-r' from common diff options, mention it only for git-diff-tree.
    Remove one extraneous use of '-r' with git-diff-files in get-merge.sh.
    Sync the synopsis and usage string for git-diff-tree.

Signed-off-by: Chris Shoemaker <c.shoemaker at cox.net>

---
My first real patch with git.  Did I do it right?

-chris 

 Documentation/git-diff-tree.txt |    5 ++++-
 diff-tree.c                     |    6 ++++--
 diff.h                          |    1 -
 git-merge.sh                    |    2 +-
 4 files changed, 9 insertions(+), 5 deletions(-)

4b20f7c39762c54c414eb92d17180064c7ccbde9
diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -8,7 +8,7 @@ git-diff-tree - Compares the content and
 
 SYNOPSIS
 --------
-'git-diff-tree' [--stdin] [-m] [-s] [-v] [--pretty] [-t] [<common diff options>] <tree-ish> [<tree-ish>] [<path>...]
+'git-diff-tree' [--stdin] [-m] [-s] [-v] [--pretty] [-t] [-r] [--root] [<common diff options>] <tree-ish> [<tree-ish>] [<path>...]
 
 DESCRIPTION
 -----------
@@ -33,6 +33,9 @@ include::diff-options.txt[]
 	Note that this parameter does not provide any wildcard or regexp
 	features.
 
+-r::
+        recurse into sub-trees
+
 -t::
 	show tree entry itself as well as subtrees.  Implies -r.
 
diff --git a/diff-tree.c b/diff-tree.c
--- a/diff-tree.c
+++ b/diff-tree.c
@@ -149,8 +149,10 @@ static int diff_tree_stdin(char *line)
 }
 
 static const char diff_tree_usage[] =
-"git-diff-tree [--stdin] [-m] [-s] [-v] [--pretty] [-t] "
-"[<common diff options>] <tree-ish> <tree-ish>"
+"git-diff-tree [--stdin] [-m] [-s] [-v] [--pretty] [-t] [-r] [--root] "
+"[<common diff options>] <tree-ish> [<tree-ish>] [<path>...]\n"
+"  -r            diff recursively\n"
+"  --root        include the initial commit as diff against /dev/null\n"
 COMMON_DIFF_OPTIONS_HELP;
 
 int main(int argc, const char **argv)
diff --git a/diff.h b/diff.h
--- a/diff.h
+++ b/diff.h
@@ -91,7 +91,6 @@ extern void diffcore_std_no_resolve(stru
 
 #define COMMON_DIFF_OPTIONS_HELP \
 "\ncommon diff options:\n" \
-"  -r            diff recursively (only meaningful in diff-tree)\n" \
 "  -z            output diff-raw with lines terminated with NUL.\n" \
 "  -p            output patch format.\n" \
 "  -u            synonym for -p.\n" \
diff --git a/git-merge.sh b/git-merge.sh
--- a/git-merge.sh
+++ b/git-merge.sh
@@ -25,7 +25,7 @@ dropsave() {
 
 savestate() {
 	# Stash away any local modifications.
-	git-diff-index -r -z --name-only $head |
+	git-diff-index -z --name-only $head |
 	cpio -0 -o >"$GIT_DIR/MERGE_SAVE"
 }
 

Re: [PATCH] Documentation changes to recursive option for git-diff-tree

[Junio C Hamano]

I already took some patches from you, but I just noticed this...

Chris Shoemaker <c.shoemaker@cox.net> writes:

> Signed-off-by: Chris Shoemaker <c.shoemaker at cox.net>

I do not particularly like this spelling out "at".

Re: [PATCH] Documentation changes to recursive option for git-diff-tree

[H. Peter Anvin]

Junio C Hamano wrote:
> I already took some patches from you, but I just noticed this...
> 
> Chris Shoemaker <c.shoemaker@cox.net> writes:
> 
> 
>>Signed-off-by: Chris Shoemaker <c.shoemaker at cox.net>
> 
> 
> I do not particularly like this spelling out "at".
> 

It also doesn't do any good.  Spam harvesters have caught onto this one 
a long time ago.
	
	-hpa

Re: [PATCH] Documentation changes to recursive option for git-diff-tree

[Chris Shoemaker]

On Fri, Oct 28, 2005 at 10:20:45PM -0700, Junio C Hamano wrote:
> I already took some patches from you, but I just noticed this...
> 
> Chris Shoemaker <c.shoemaker@cox.net> writes:
> 
> > Signed-off-by: Chris Shoemaker <c.shoemaker at cox.net>
> 
> I do not particularly like this spelling out "at".

That resulted from GIT_AUTHOR_IDENT="c.shoemaker<at>cox.net".  I think
I copied that format from somewhere, but I see now that the logs
contain regular addresses.  I've changed it to just
"c.shoemaker@cox.net".

-chris

> 
>