Re: [PATCH] doc: mention 'git show' defaults to HEAD

From: Junio C Hamano <gitster@pobox.com>
Date: Jan 30, 2018, 21:11 UTC
Message-ID: <xmqqzi4vrr09.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <20180128191607.31199-1-tmz@pobox.com>

Todd Zullinger <tmz@pobox.com> writes:

Show 11 quoted lines

> When 'git show' is called without any object it defaults to HEAD.  This
> has been true since d4ed9793fd ("Simplify common default options setup
> for built-in log family.", 2006-04-16).
>
> The SYNOPSIS suggests that the object argument is required.  Clarify
> that it is not required and note the default.
>
> Signed-off-by: Todd Zullinger <tmz@pobox.com>
> ---
> This was mentioned in #git today by qaz.  It seems reasonable to document the
> default.

Sounds sensible.

Show 25 quoted lines

>
>  Documentation/git-show.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt
> index 82a4125a2d..e73ef54017 100644
> --- a/Documentation/git-show.txt
> +++ b/Documentation/git-show.txt
> @@ -9,7 +9,7 @@ git-show - Show various types of objects
>  SYNOPSIS
>  --------
>  [verse]
> -'git show' [options] <object>...
> +'git show' [options] [<object>...]
>  
>  DESCRIPTION
>  -----------
> @@ -35,7 +35,7 @@ This manual page describes only the most frequently used options.
>  OPTIONS
>  -------
>  <object>...::
> -	The names of objects to show.
> +	The names of objects to show (defaults to 'HEAD').
>  	For a more complete list of ways to spell object names, see
>  	"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].