git-verify-* doc: update mark-up of synopsis option descriptions
To unify mark-up used in our documentation to a newer convention,
started by 22293895 (doc: apply synopsis simplification on git-clone
and git-init, 2024-09-24), update the documentation pages for 'git
verify-commit', 'git verify-tag', and 'git verify-pack' to
* use [synopsis], not [verse] in the SYNOPSIS section
* enclose `--option=<value>` in backquotes
* do not describe non-option arguments in the OPTIONS section
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
@@ -7,26 +7,24 @@ git-verify-commit - Check the GPG signature of commits
|
|||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
[verse]
|
[synopsis]
|
||||||
'git verify-commit' [-v | --verbose] [--raw] <commit>...
|
git verify-commit [-v | --verbose] [--raw] <commit>...
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Validates the GPG signature created by 'git commit -S'.
|
Validates the GPG signature created by `git commit -S`
|
||||||
|
on the commit objects given on the command line.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
--raw::
|
`--raw`::
|
||||||
Print the raw gpg status output to standard error instead of the normal
|
Print the raw gpg status output to standard error instead of the normal
|
||||||
human-readable output.
|
human-readable output.
|
||||||
|
|
||||||
-v::
|
`-v`::
|
||||||
--verbose::
|
`--verbose`::
|
||||||
Print the contents of the commit object before validating it.
|
Print the contents of the commit object before validating it.
|
||||||
|
|
||||||
<commit>...::
|
|
||||||
SHA-1 identifiers of Git commit objects.
|
|
||||||
|
|
||||||
GIT
|
GIT
|
||||||
---
|
---
|
||||||
Part of the linkgit:git[1] suite
|
Part of the linkgit:git[1] suite
|
||||||
|
|||||||
@@ -8,43 +8,39 @@ git-verify-pack - Validate packed Git archive files
|
|||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
[verse]
|
[synopsis]
|
||||||
'git verify-pack' [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...
|
git verify-pack [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Reads given idx file for packed Git archive created with the
|
Read each idx file for packed Git archive given on the command line,
|
||||||
'git pack-objects' command and verifies the idx file and the
|
and verify the idx file and the corresponding pack file.
|
||||||
corresponding pack file.
|
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
<pack>.idx ...::
|
`-v`::
|
||||||
The idx files to verify.
|
`--verbose`::
|
||||||
|
|
||||||
-v::
|
|
||||||
--verbose::
|
|
||||||
After verifying the pack, show the list of objects contained
|
After verifying the pack, show the list of objects contained
|
||||||
in the pack and a histogram of delta chain length.
|
in the pack and a histogram of delta chain length.
|
||||||
|
|
||||||
-s::
|
`-s`::
|
||||||
--stat-only::
|
`--stat-only`::
|
||||||
Do not verify the pack contents; only show the histogram of delta
|
Do not verify the pack contents; only show the histogram of delta
|
||||||
chain length. With `--verbose`, the list of objects is also shown.
|
chain length. With `--verbose`, the list of objects is also shown.
|
||||||
|
|
||||||
\--::
|
`--`::
|
||||||
Do not interpret any more arguments as options.
|
Do not interpret any more arguments as options.
|
||||||
|
|
||||||
OUTPUT FORMAT
|
OUTPUT FORMAT
|
||||||
-------------
|
-------------
|
||||||
When specifying the -v option the format used is:
|
When specifying the `-v` option the format used is:
|
||||||
|
|
||||||
SHA-1 type size size-in-packfile offset-in-packfile
|
object-name type size size-in-packfile offset-in-packfile
|
||||||
|
|
||||||
for objects that are not deltified in the pack, and
|
for objects that are not deltified in the pack, and
|
||||||
|
|
||||||
SHA-1 type size size-in-packfile offset-in-packfile depth base-SHA-1
|
object-name type size size-in-packfile offset-in-packfile depth base-object-name
|
||||||
|
|
||||||
for objects that are deltified.
|
for objects that are deltified.
|
||||||
|
|
||||||
|
|||||||
@@ -7,26 +7,24 @@ git-verify-tag - Check the GPG signature of tags
|
|||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
[verse]
|
[synopsis]
|
||||||
'git verify-tag' [-v | --verbose] [--format=<format>] [--raw] <tag>...
|
git verify-tag [-v | --verbose] [--format=<format>] [--raw] <tag>...
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Validates the gpg signature created by 'git tag'.
|
Validates the gpg signature created by `git tag` in the tag
|
||||||
|
objects listed on the command line.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
--raw::
|
`--raw`::
|
||||||
Print the raw gpg status output to standard error instead of the normal
|
Print the raw gpg status output to standard error instead of the normal
|
||||||
human-readable output.
|
human-readable output.
|
||||||
|
|
||||||
-v::
|
`-v`::
|
||||||
--verbose::
|
`--verbose`::
|
||||||
Print the contents of the tag object before validating it.
|
Print the contents of the tag object before validating it.
|
||||||
|
|
||||||
<tag>...::
|
|
||||||
SHA-1 identifiers of Git tag objects.
|
|
||||||
|
|
||||||
GIT
|
GIT
|
||||||
---
|
---
|
||||||
Part of the linkgit:git[1] suite
|
Part of the linkgit:git[1] suite
|
||||||
|
|||||||
Reference in New Issue
Block a user