Re: [PATCH] doc/diff-options: fix out of place mentions of '--patch/-p'
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Nov 2, 2020, 18:11 UTC
- Message-ID
- <xmqq7dr3wrwm.fsf@gitster.c.googlers.com>
- In-Reply-To
- <20201031193734.22702-1-sorganov@gmail.com>
Sergey Organov <sorganov@gmail.com> writes:
> First, references to --patch and -p appeared in the description of > git-format-patch, where the options themselves are not included.
Fun. The -U<n> option in "git diff-index -U9" implicitly turns "--patch" on, but it is hard to say that the same option in "git format-patch -U9" turns "--patch" on, as it is in effect even without the -U<n> option.
It makes readers wonder what, if anything, needs to be done for "git diff -U9", but let's leave it out of the scope of this change, which is strict improvement for "format-patch" documentation.
Thanks.
Show 36 quoted lines
> Next, the description of --unified option elsewhere had duplicate implied > statements: "Implies --patch. Implies -p." > > Signed-off-by: Sergey Organov <sorganov@gmail.com> > --- > Documentation/diff-options.txt | 9 ++++++--- > 1 file changed, 6 insertions(+), 3 deletions(-) > > diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt > index 573fb9bb71e2..320304033483 100644 > --- a/Documentation/diff-options.txt > +++ b/Documentation/diff-options.txt > @@ -36,9 +36,9 @@ endif::git-format-patch[] > -U<n>:: > --unified=<n>:: > Generate diffs with <n> lines of context instead of > - the usual three. Implies `--patch`. > + the usual three. > ifndef::git-format-patch[] > - Implies `-p`. > + Implies `--patch`. > endif::git-format-patch[] > > --output=<file>:: > @@ -441,7 +441,10 @@ endif::git-format-patch[] > > --binary:: > In addition to `--full-index`, output a binary diff that > - can be applied with `git-apply`. Implies `--patch`. > + can be applied with `git-apply`. > +ifndef::git-format-patch[] > + Implies `--patch`. > +endif::git-format-patch[] > > --abbrev[=<n>]:: > Instead of showing the full 40-byte hexadecimal object