git-diff: fix missing --merge-base docs
commiteb448631fb541239d91709d812b92bf2b57bc733
authorDenton Liu <liu.denton@gmail.com>
Sat, 10 Jul 2021 09:28:31 +0000 (10 02:28 -0700)
committerJunio C Hamano <gitster@pobox.com>
Mon, 12 Jul 2021 20:55:29 +0000 (12 13:55 -0700)
tree85ba0ef1bf1d011fb361ad755fd642c87ecf2e0e
parentcce7d6ecfc45f0d74a95c6ca6447d6e327791348
git-diff: fix missing --merge-base docs

When `git diff --merge-base` was introduced at around Git 2.30, the
documentation included a few errors.

In the example given for `git diff --cached --merge-base`, the
`--cached` flag was omitted for the `--merge-base` example. Add the
missing flag.

In the `git diff <commit>` case, we failed to mention that
`--merge-base` is an available option. Give the usage of `--merge-base`
as an option there.

Finally, there are two errors in the usage of `git diff`. Firstly, we do
not mention `--merge-base` in the `git diff --cached` case. Mention it
so that it's consistent with the documentation. Secondly, we put the
`[--merge-base]` in between `<commit>` and `[<commit>...]`. Move the
`[--merge-base]` so that it's beside `[<options>]` which is a more
logical grouping.

Signed-off-by: Denton Liu <liu.denton@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-diff.txt
builtin/diff.c