Skip to content

Commit 7e7f47a

Browse files
committed
git-verify-* doc: update mark-up of synopsis option descriptions
To unify mark-up used in our documentation to a newer convention, started by 2229389 (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 <[email protected]> Helped-by: Jean-Noël Avila <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 914c549 commit 7e7f47a

File tree

3 files changed

+26
-34
lines changed

3 files changed

+26
-34
lines changed

Documentation/git-verify-commit.adoc

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,24 @@ git-verify-commit - Check the GPG signature of commits
77

88
SYNOPSIS
99
--------
10-
[verse]
11-
'git verify-commit' [-v | --verbose] [--raw] <commit>...
10+
[synopsis]
11+
git verify-commit [-v | --verbose] [--raw] <commit>...
1212

1313
DESCRIPTION
1414
-----------
15-
Validates the GPG signature created by 'git commit -S'.
15+
Validates the GPG signature created by `git commit -S`
16+
on the commit objects given on the command line.
1617

1718
OPTIONS
1819
-------
19-
--raw::
20+
`--raw`::
2021
Print the raw gpg status output to standard error instead of the normal
2122
human-readable output.
2223

23-
-v::
24-
--verbose::
24+
`-v`::
25+
`--verbose`::
2526
Print the contents of the commit object before validating it.
2627

27-
<commit>...::
28-
SHA-1 identifiers of Git commit objects.
29-
3028
GIT
3129
---
3230
Part of the linkgit:git[1] suite

Documentation/git-verify-pack.adoc

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,43 +8,39 @@ git-verify-pack - Validate packed Git archive files
88

99
SYNOPSIS
1010
--------
11-
[verse]
12-
'git verify-pack' [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...
11+
[synopsis]
12+
git verify-pack [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...
1313

1414

1515
DESCRIPTION
1616
-----------
17-
Reads given idx file for packed Git archive created with the
18-
'git pack-objects' command and verifies the idx file and the
19-
corresponding pack file.
17+
Read each idx file for packed Git archive given on the command line,
18+
and verify the idx file and the corresponding pack file.
2019

2120
OPTIONS
2221
-------
23-
<pack>.idx ...::
24-
The idx files to verify.
25-
26-
-v::
27-
--verbose::
22+
`-v`::
23+
`--verbose`::
2824
After verifying the pack, show the list of objects contained
2925
in the pack and a histogram of delta chain length.
3026

31-
-s::
32-
--stat-only::
27+
`-s`::
28+
`--stat-only`::
3329
Do not verify the pack contents; only show the histogram of delta
3430
chain length. With `--verbose`, the list of objects is also shown.
3531

36-
\--::
32+
`--`::
3733
Do not interpret any more arguments as options.
3834

3935
OUTPUT FORMAT
4036
-------------
41-
When specifying the -v option the format used is:
37+
When specifying the `-v` option the format used is:
4238

43-
SHA-1 type size size-in-packfile offset-in-packfile
39+
object-name type size size-in-packfile offset-in-packfile
4440

4541
for objects that are not deltified in the pack, and
4642

47-
SHA-1 type size size-in-packfile offset-in-packfile depth base-SHA-1
43+
object-name type size size-in-packfile offset-in-packfile depth base-object-name
4844

4945
for objects that are deltified.
5046

Documentation/git-verify-tag.adoc

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,24 @@ git-verify-tag - Check the GPG signature of tags
77

88
SYNOPSIS
99
--------
10-
[verse]
11-
'git verify-tag' [-v | --verbose] [--format=<format>] [--raw] <tag>...
10+
[synopsis]
11+
git verify-tag [-v | --verbose] [--format=<format>] [--raw] <tag>...
1212

1313
DESCRIPTION
1414
-----------
15-
Validates the gpg signature created by 'git tag'.
15+
Validates the gpg signature created by `git tag` in the tag
16+
objects listed on the command line.
1617

1718
OPTIONS
1819
-------
19-
--raw::
20+
`--raw`::
2021
Print the raw gpg status output to standard error instead of the normal
2122
human-readable output.
2223

23-
-v::
24-
--verbose::
24+
`-v`::
25+
`--verbose`::
2526
Print the contents of the tag object before validating it.
2627

27-
<tag>...::
28-
SHA-1 identifiers of Git tag objects.
29-
3028
GIT
3129
---
3230
Part of the linkgit:git[1] suite

0 commit comments

Comments
 (0)