* [PATCH] doc: mention 'git show' defaults to HEAD
@ 2018-01-28 19:16 Todd Zullinger
2018-01-30 21:11 ` Junio C Hamano
0 siblings, 1 reply; 2+ messages in thread
From: Todd Zullinger @ 2018-01-28 19:16 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git
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.
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].
--
2.16.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] doc: mention 'git show' defaults to HEAD
2018-01-28 19:16 [PATCH] doc: mention 'git show' defaults to HEAD Todd Zullinger
@ 2018-01-30 21:11 ` Junio C Hamano
0 siblings, 0 replies; 2+ messages in thread
From: Junio C Hamano @ 2018-01-30 21:11 UTC (permalink / raw)
To: Todd Zullinger; +Cc: git
Todd Zullinger <tmz@pobox.com> writes:
> 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.
>
> 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].
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-01-30 21:11 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-01-28 19:16 [PATCH] doc: mention 'git show' defaults to HEAD Todd Zullinger
2018-01-30 21:11 ` Junio C Hamano
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).