Re: [PATCH] git show documentation: no longer refer to git-diff-tree options

[Junio C Hamano <gitster@pobox.com>]

Miklos Vajna <vmiklos@frugalware.org> writes:

> I just checked each option one by one and right, I haven't found any
> other option that could be useful for git-show either. Given that the
> wording of -s for git-show is quite different, I think it would be
> easier to just document -s in git-show as well. Like this?

Hmm, yes but not exactly.

You lost --stat, --name-only and friends that were implied by mentioning
"diff-tree".

I agree your _motivation_ behind your original patch is good.  Saying "see
also that page if you want to do very exotic and rarely useful operation"
is one thing, but saying "described are most often used ones" and not
describing enough is bad.

Perhaps we would want to include diff-options.txt.  There may be some
options that are no-op or always-on in the context of "git show" in the
file, but we already have an infrastracture to turn parts of the inclusion
on and off depending on which manual page includes it.

> diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt
> index dccf0e2..299b611 100644
> --- a/Documentation/git-show.txt
> +++ b/Documentation/git-show.txt
> @@ -25,12 +25,6 @@ with \--name-only).
>  
>  For plain blobs, it shows the plain contents.
>  
> -The command takes options applicable to the linkgit:git-diff-tree[1] command to
> -control how the changes the commit introduces are shown.
> -
> -This manual page describes only the most frequently used options.
> -
> -
>  OPTIONS
>  -------
>  <object>::
> @@ -38,6 +32,9 @@ OPTIONS
>  	For a more complete list of ways to spell object names, see
>  	"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
>  
> +-s::
> +	Don't show a textural diff for commits.
> +
>  include::pretty-options.txt[]
>  
>  
> -- 
> 1.5.5.1.91.g499fc.dirty