doc: fix descripion for 'git tag --format'
The '--format=<format>' is now listed in the 'OPTIONS' section, not only the '<format>' string itself. The description moved up a few paragraphs because '<format>' is not a standalone paramater but a parameter for the option '--format'. Signed-off-by: Andreas Heiduk <asheiduk@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Andreas Heiduk committed
Oct 22, 2018 at 22:45 UTC
a5e14ea1397f933ab188b2afd6685974044be88d
1 file changed
+6
-6
Documentation/git-tag.txt
+6
-6
@@ -187,6 +187,12 @@ This option is only applicable when listing tags without annotation lines.
187
`--create-reflog`, but currently does not negate the setting of
188
`core.logAllRefUpdates`.
189
190
+--format=<format>::
191
+ A string that interpolates `%(fieldname)` from a tag ref being shown
192
+ and the object it points at. The format is the same as
193
+ that of linkgit:git-for-each-ref[1]. When unspecified,
194
+ defaults to `%(refname:strip=2)`.
195
+
196
<tagname>::
197
The name of the tag to create, delete, or describe.
198
The new tag name must pass all checks defined by
@@ -198,12 +204,6 @@ This option is only applicable when listing tags without annotation lines.
204
The object that the new tag will refer to, usually a commit.
205
Defaults to HEAD.
206
201
-<format>::
202
- A string that interpolates `%(fieldname)` from a tag ref being shown
203
- and the object it points at. The format is the same as
204
- that of linkgit:git-for-each-ref[1]. When unspecified,
205
- defaults to `%(refname:strip=2)`.
206
-
207
CONFIGURATION
208
-------------
209
By default, 'git tag' in sign-with-default mode (-s) will use your