git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Sergey Organov <sorganov@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] doc/diff-options: fix out of place mentions of '--patch/-p'
Date: Mon, 02 Nov 2020 10:11:05 -0800	[thread overview]
Message-ID: <xmqq7dr3wrwm.fsf@gitster.c.googlers.com> (raw)
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.

> 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

      reply	other threads:[~2020-11-02 18:11 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-31 19:37 [PATCH] doc/diff-options: fix out of place mentions of '--patch/-p' Sergey Organov
2020-11-02 18:11 ` Junio C Hamano [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqq7dr3wrwm.fsf@gitster.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=sorganov@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).