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>
Junio C Hamano committed
May 10, 2025 at 14:33 UTC
7e7f47a48853a520db606bcd2269bb17cba09744
3 files changed
+26
-34
Documentation/git-verify-commit.adoc
+7
-9
@@ -7,26 +7,24 @@ git-verify-commit - Check the GPG signature of commits
7
8
SYNOPSIS
9
--------
10
-[verse]
11
-'git verify-commit' [-v | --verbose] [--raw] <commit>...
10
+[synopsis]
11
+git verify-commit [-v | --verbose] [--raw] <commit>...
12
13
DESCRIPTION
14
-----------
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.
17
18
OPTIONS
19
-------
19
---raw::
20
+`--raw`::
21
Print the raw gpg status output to standard error instead of the normal
22
human-readable output.
23
23
--v::
24
---verbose::
24
+`-v`::
25
+`--verbose`::
26
Print the contents of the commit object before validating it.
27
27
-<commit>...::
28
- SHA-1 identifiers of Git commit objects.
29
-
28
GIT
29
---
30
Part of the linkgit:git[1] suite
Documentation/git-verify-pack.adoc
+12
-16
@@ -8,43 +8,39 @@ git-verify-pack - Validate packed Git archive files
8
9
SYNOPSIS
10
--------
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...
13
14
15
DESCRIPTION
16
-----------
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.
19
20
OPTIONS
21
-------
23
-<pack>.idx ...::
24
- The idx files to verify.
25
-
26
--v::
27
---verbose::
22
+`-v`::
23
+`--verbose`::
24
After verifying the pack, show the list of objects contained
25
in the pack and a histogram of delta chain length.
26
31
--s::
32
---stat-only::
27
+`-s`::
28
+`--stat-only`::
29
Do not verify the pack contents; only show the histogram of delta
30
chain length. With `--verbose`, the list of objects is also shown.
31
36
-\--::
32
+`--`::
33
Do not interpret any more arguments as options.
34
35
OUTPUT FORMAT
36
-------------
41
-When specifying the -v option the format used is:
37
+When specifying the `-v` option the format used is:
38
43
- SHA-1 type size size-in-packfile offset-in-packfile
39
+ object-name type size size-in-packfile offset-in-packfile
40
41
for objects that are not deltified in the pack, and
42
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
44
45
for objects that are deltified.
46
Documentation/git-verify-tag.adoc
+7
-9
@@ -7,26 +7,24 @@ git-verify-tag - Check the GPG signature of tags
7
8
SYNOPSIS
9
--------
10
-[verse]
11
-'git verify-tag' [-v | --verbose] [--format=<format>] [--raw] <tag>...
10
+[synopsis]
11
+git verify-tag [-v | --verbose] [--format=<format>] [--raw] <tag>...
12
13
DESCRIPTION
14
-----------
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.
17
18
OPTIONS
19
-------
19
---raw::
20
+`--raw`::
21
Print the raw gpg status output to standard error instead of the normal
22
human-readable output.
23
23
--v::
24
---verbose::
24
+`-v`::
25
+`--verbose`::
26
Print the contents of the tag object before validating it.
27
27
-<tag>...::
28
- SHA-1 identifiers of Git tag objects.
29
-
28
GIT
29
---
30
Part of the linkgit:git[1] suite