Browse Source

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>
maint
Andreas Heiduk 6 years ago committed by Junio C Hamano
parent
commit
a5e14ea139
  1. 12
      Documentation/git-tag.txt

12
Documentation/git-tag.txt

@ -187,6 +187,12 @@ This option is only applicable when listing tags without annotation lines.
`--create-reflog`, but currently does not negate the setting of `--create-reflog`, but currently does not negate the setting of
`core.logAllRefUpdates`. `core.logAllRefUpdates`.


--format=<format>::
A string that interpolates `%(fieldname)` from a tag ref being shown
and the object it points at. The format is the same as
that of linkgit:git-for-each-ref[1]. When unspecified,
defaults to `%(refname:strip=2)`.

<tagname>:: <tagname>::
The name of the tag to create, delete, or describe. The name of the tag to create, delete, or describe.
The new tag name must pass all checks defined by 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.
The object that the new tag will refer to, usually a commit. The object that the new tag will refer to, usually a commit.
Defaults to HEAD. Defaults to HEAD.


<format>::
A string that interpolates `%(fieldname)` from a tag ref being shown
and the object it points at. The format is the same as
that of linkgit:git-for-each-ref[1]. When unspecified,
defaults to `%(refname:strip=2)`.

CONFIGURATION CONFIGURATION
------------- -------------
By default, 'git tag' in sign-with-default mode (-s) will use your By default, 'git tag' in sign-with-default mode (-s) will use your

Loading…
Cancel
Save