[PATCH v2] git-diff.txt: document return code of `--no-index`
- From
Denton Liu <liu.denton@gmail.com>
- Date
- Oct 29, 2019, 16:54 UTC
- Message-ID
- <ed9f16c30a0f3852abaf0053d8c2b4a0ecd12f01.1572367897.git.liu.denton@gmail.com>
- In-Reply-To
- <3f6d132663cacde01df68bfe88c6ef108cf6cf74.1572337045.git.liu.denton@gmail.com>
Within diff_no_index(), we have the following:
revs->diffopt.flags.exit_with_status = 1;
...
/* * The return code for --no-index imitates diff(1): * 0 = no changes, 1 = changes, else error */ return diff_result_code(&revs->diffopt, 0);
Which means when `git diff` is run in `--no-index` mode, `--exit-code` is implied. However, the documentation for this is missing in git-diff.txt.
Add a note about how `--exit-code` is implied in the `--no-index` documentation to cover this documentation blindspot.
Signed-off-by: Denton Liu <liu.denton@gmail.com> --- Thanks for the review, Dscho. I guess it slipped my mind that we could write it this way too. Oops!
Documentation/git-diff.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 72179d993c..56b396ef81 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -36,7 +36,7 @@ two blob objects, or changes between two files on disk. running the command in a working tree controlled by Git and at least one of the paths points outside the working tree, or when running the command outside a working tree - controlled by Git. + controlled by Git. This form implies `--no-exit`. 'git diff' [<options>] --cached [<commit>] [--] [<path>...]::
-- 2.24.0.rc0.197.g0926ab8072