Thread (1 message) 1 message, 1 author, 2016-06-15

Re: [PATCH] git-tag(1): we tag HEAD by default

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:56:37

Thomas Rast [off-list ref] writes:
The <commit>|<object> argument is actually not explained anywhere
(except implicitly in the description of an unannotated tag).  Write a
little explanation, in particular to cover the default.

Signed-off-by: Thomas Rast <redacted>
---

Prompted by a question on IRC about the default value.  Do we actually
read our own docs? ;-)
Perhaps among us some of them are real men ;-)
quoted hunk
 Documentation/git-tag.txt | 5 +++++
 1 file changed, 5 insertions(+)
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index e3032c4..697df50 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -126,6 +126,11 @@ This option is only applicable when listing tags without annotation lines.
 	linkgit:git-check-ref-format[1].  Some of these checks
 	may restrict the characters allowed in a tag name.
 
+<commit>, <object>::
+	The object that the new tag will refer to, usually a commit.
+	Defaults to HEAD.
Shouldn't this be more like this:

    <commit>::
    <object>::
	Your explanation here...

Other than that, I think this is a reasonable change.
Thanks.
+
+
 CONFIGURATION
 -------------
 By default, 'git tag' in sign-with-default mode (-s) will use your
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help