Re: [PATCH v2] show doc: redirect user to git log manual instead of git diff-tree

From: Junio C Hamano <gitster@pobox.com>
Date: Sep 20, 2023, 15:52 UTC
Message-ID: <xmqqpm2calkx.fsf@gitster.g>
In-Reply-To: <20230920132731.1259-1-hanyang.tony@bytedance.com>

Han Young <hanyang.tony@bytedance.com> writes:

Show 10 quoted lines

> While git show accepts options that apply to the git diff-tree command,
> some options do not make sense in the context of git show.
> The options of git show are handled using the machinery of git log.
> The git log manual page is a better place to look into than git diff-tree
> for options that are not in the git show manual page.
>
> Signed-off-by: Han Young <hanyang.tony@bytedance.com>
> ---
> Changes since v1:
> * change wording to clarify not all options of `git log` are meant for `git show`

Nice.  Thank you very much for not forgetting this topic.

Show 16 quoted lines

>  Documentation/git-show.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt
> index 2b1bc7288d..fc46b3687b 100644
> --- a/Documentation/git-show.txt
> +++ b/Documentation/git-show.txt
> @@ -26,7 +26,7 @@ with --name-only).
>  
>  For plain blobs, it shows the plain contents.
>  
> -The command takes options applicable to the 'git diff-tree' command to
> +Some options that 'git log' command understands can be used to
>  control how the changes the commit introduces are shown.
>  
>  This manual page describes only the most frequently used options.