Documentation changes to recursive option for git-diff-tree

spot · Junio C Hamano · commit 50b8e355b64c · 2005-10-28T13:37:38.000-07:00
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 &lt;c.shoemaker at cox.net&gt;
Signed-off-by: Junio C Hamano &lt;junkio@cox.net&gt;
diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
@@ -8,7 +8,7 @@ git-diff-tree - Compares the content and mode of blobs found via two tree object
 
 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
@@ -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
@@ -91,7 +91,6 @@ extern void diffcore_std_no_resolve(struct diff_options *);
 
 #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
@@ -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"
 }
 

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ dropsave() {`
`25`	`25`
`26`	`26`	`savestate() {`
`27`	`27`	`# Stash away any local modifications.`
`28`		`- git-diff-index -r -z --name-only $head \|`
	`28`	`+ git-diff-index -z --name-only $head \|`
`29`	`29`	`cpio -0 -o >"$GIT_DIR/MERGE_SAVE"`
`30`	`30`	`}`
`31`	`31`