From 4c81c213a479e4aae0653a56ad6e8db5c31f019c Mon Sep 17 00:00:00 2001 From: Andreas Ericsson Date: Thu, 30 Nov 2006 12:43:13 +0100 Subject: git-diff: Introduce --index and deprecate --cached. 'git diff --cached' still works, but its use is discouraged in the documentation. 'git diff --index' does the same thing and is consistent with how 'git apply --index' works. Signed-off-by: Andreas Ericsson Signed-off-by: Junio C Hamano --- Documentation/git-diff.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'Documentation/git-diff.txt') diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 228c4d95bd..3144864d85 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -22,8 +22,10 @@ the number of trees given to the command. * When one is given, the working tree and the named tree are compared, using `git-diff-index`. The option - `--cached` can be given to compare the index file and + `--index` can be given to compare the index file and the named tree. + `--cached` is a deprecated alias for `--index`. It's use is + discouraged. * When two s are given, these two trees are compared using `git-diff-tree`. @@ -47,7 +49,7 @@ Various ways to check your working tree:: + ------------ $ git diff <1> -$ git diff --cached <2> +$ git diff --index <2> $ git diff HEAD <3> ------------ + -- cgit v1.3 From f2dd1c9adfe961ea611545b018bc67e5d83ee3db Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 13 Dec 2006 01:33:43 -0800 Subject: Revert "git-diff: Introduce --index and deprecate --cached." This reverts commit 4c81c213a479e4aae0653a56ad6e8db5c31f019c. Although --cached and --index are confusing wording, the use of word --cached for git-diff is consistent with git-apply. It means "work with index without looking at the working tree". We should probably come up with better wording for --cached, if somebody wants to deprecate it. But making --index and --cached synonyms for diff while leaving them mean different things for apply is no good. --- Documentation/git-diff.txt | 6 ++---- builtin-diff.c | 2 +- 2 files changed, 3 insertions(+), 5 deletions(-) (limited to 'Documentation/git-diff.txt') diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 3144864d85..228c4d95bd 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -22,10 +22,8 @@ the number of trees given to the command. * When one is given, the working tree and the named tree are compared, using `git-diff-index`. The option - `--index` can be given to compare the index file and + `--cached` can be given to compare the index file and the named tree. - `--cached` is a deprecated alias for `--index`. It's use is - discouraged. * When two s are given, these two trees are compared using `git-diff-tree`. @@ -49,7 +47,7 @@ Various ways to check your working tree:: + ------------ $ git diff <1> -$ git diff --index <2> +$ git diff --cached <2> $ git diff HEAD <3> ------------ + diff --git a/builtin-diff.c b/builtin-diff.c index 1c535b1dd6..a6590205e8 100644 --- a/builtin-diff.c +++ b/builtin-diff.c @@ -137,7 +137,7 @@ static int builtin_diff_index(struct rev_info *revs, int cached = 0; while (1 < argc) { const char *arg = argv[1]; - if (!strcmp(arg, "--index") || !strcmp(arg, "--cached")) + if (!strcmp(arg, "--cached")) cached = 1; else usage(builtin_diff_usage); -- cgit v1.3 From f5e6b89b3a4420481a6ecdc05df325cb6d69d114 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 14 Dec 2006 00:03:18 -0800 Subject: Update git-diff documentation Porcelain documentation should talk in terms of end-user workflow, not in terms of implementation details. Do not suggest update-index, but git-add instead. Explain differences among 0-, 1- and 2-tree cases not as differences of number of trees given to the command, but say why user would want to give these number of trees to the command in what situation. Signed-off-by: Junio C Hamano --- Documentation/git-diff.txt | 52 +++++++++++++++++++++++++++++++--------------- 1 file changed, 35 insertions(+), 17 deletions(-) (limited to 'Documentation/git-diff.txt') diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 228c4d95bd..127d68c962 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -14,30 +14,48 @@ DESCRIPTION ----------- Show changes between two trees, a tree and the working tree, a tree and the index file, or the index file and the working tree. -The combination of what is compared with what is determined by -the number of trees given to the command. -* When no is given, the working tree and the index - file are compared, using `git-diff-files`. +'git-diff' [--options] [--] [...]:: -* When one is given, the working tree and the named - tree are compared, using `git-diff-index`. The option - `--cached` can be given to compare the index file and - the named tree. + This form is to view the changes you made relative to + the index (staging area for the next commit). In other + words, the differences are what you _could_ tell git to + further add to the index but you still haven't. You can + stage these changes by using gitlink:git-add[1]. + +'git-diff' [--options] --cached [] [--] [...]:: + + This form is to view the changes you staged for the next + commit relative to the named . Typically you + would want comparison with the latest commit, so if you + do not give , it defaults to HEAD. + +'git-diff' [--options] -- [...]:: + + This form is to view the changes you have in your + working tree relative to the named . You can + use HEAD to compare it with the latest commit, or a + branch name to compare with the tip of a different + branch. + +'git-diff' [--options] -- [...]:: + + This form is to view the changes between two , + for example, tips of two branches. + +Just in case if you are doing something exotic, it should be +noted that all of the in the above description can be +any . -* When two s are given, these two trees are compared - using `git-diff-tree`. OPTIONS ------- ---diff-options:: - '--diff-options' are passed to the `git-diff-files`, - `git-diff-index`, and `git-diff-tree` commands. See the - documentation for these commands for description. +include::diff-options.txt[] ...:: - The arguments are also passed to `git-diff-\*` - commands. + The parameters, when given, are used to limit + the diff to the named paths (you can give directory + names and get diff for all files under them). EXAMPLES @@ -51,7 +69,7 @@ $ git diff --cached <2> $ git diff HEAD <3> ------------ + -<1> changes in the working tree since your last git-update-index. +<1> changes in the working tree not yet staged for the next commit. <2> changes between the index and your last commit; what you would be committing if you run "git commit" without "-a" option. <3> changes in the working tree since your last commit; what you -- cgit v1.3 From e697e4cd1fc492e312a396211bafc629d6297ebd Mon Sep 17 00:00:00 2001 From: Brian Gernhardt Date: Fri, 15 Dec 2006 07:39:33 -0500 Subject: Make git-diff documentation use [--] when it should. Two of the cases has "[--] [...]" and two had "-- [...]". Not terribly consistent and potentially confusing. Also add "[--]" to the synopsis so that it's obvious you can use it from the very beginning. Signed-off-by: Brian Gernhardt Signed-off-by: Junio C Hamano --- Documentation/git-diff.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Documentation/git-diff.txt') diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 127d68c962..10fdf88dce 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -8,7 +8,7 @@ git-diff - Show changes between commits, commit and working tree, etc SYNOPSIS -------- -'git-diff' [ --diff-options ] {0,2} [...] +'git-diff' [ --diff-options ] {0,2} [--] [...] DESCRIPTION ----------- @@ -30,7 +30,7 @@ tree and the index file, or the index file and the working tree. would want comparison with the latest commit, so if you do not give , it defaults to HEAD. -'git-diff' [--options] -- [...]:: +'git-diff' [--options] [--] [...]:: This form is to view the changes you have in your working tree relative to the named . You can @@ -38,7 +38,7 @@ tree and the index file, or the index file and the working tree. branch name to compare with the tip of a different branch. -'git-diff' [--options] -- [...]:: +'git-diff' [--options] [--] [...]:: This form is to view the changes between two , for example, tips of two branches. -- cgit v1.3 From ce0545455a09113a8ece8f80c87ec61110569940 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 20 Dec 2006 14:41:54 -0800 Subject: diff documentation: mostly talk about This corrects minor remaining bits that still talked about ; the Porcelain users (as opposed to plumbers) are mostly interested in commits so use consistently and keep a sentence that mentions that can be used in place of them. --- Documentation/git-diff.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/git-diff.txt') diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 10fdf88dce..8977877b21 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -8,7 +8,7 @@ git-diff - Show changes between commits, commit and working tree, etc SYNOPSIS -------- -'git-diff' [ --diff-options ] {0,2} [--] [...] +'git-diff' [ --diff-options ] {0,2} [--] [...] DESCRIPTION ----------- @@ -26,7 +26,7 @@ tree and the index file, or the index file and the working tree. 'git-diff' [--options] --cached [] [--] [...]:: This form is to view the changes you staged for the next - commit relative to the named . Typically you + commit relative to the named . Typically you would want comparison with the latest commit, so if you do not give , it defaults to HEAD. -- cgit v1.3