From: Junio C Hamano <gitster@pobox.com>
To: git@vger.kernel.org
Subject: [PATCH 1/4] git-verify-* doc: update mark-up of synopsis option descriptions
Date: Thu, 1 May 2025 14:34:11 -0700 [thread overview]
Message-ID: <20250501213414.370514-2-gitster@pobox.com> (raw)
In-Reply-To: <20250501213414.370514-1-gitster@pobox.com>
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>
---
Documentation/git-verify-commit.adoc | 16 +++++++---------
Documentation/git-verify-pack.adoc | 28 ++++++++++++----------------
Documentation/git-verify-tag.adoc | 16 +++++++---------
3 files changed, 26 insertions(+), 34 deletions(-)
diff --git a/Documentation/git-verify-commit.adoc b/Documentation/git-verify-commit.adoc
index aee4c40eac..ff5b8b97ef 100644
--- a/Documentation/git-verify-commit.adoc
+++ b/Documentation/git-verify-commit.adoc
@@ -7,26 +7,24 @@ git-verify-commit - Check the GPG signature of commits
SYNOPSIS
--------
-[verse]
-'git verify-commit' [-v | --verbose] [--raw] <commit>...
+[synopsis]
+git verify-commit [-v | --verbose] [--raw] <commit>...
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
-------
---raw::
+`--raw`::
Print the raw gpg status output to standard error instead of the normal
human-readable output.
--v::
---verbose::
+`-v`::
+`--verbose`::
Print the contents of the commit object before validating it.
-<commit>...::
- SHA-1 identifiers of Git commit objects.
-
GIT
---
Part of the linkgit:git[1] suite
diff --git a/Documentation/git-verify-pack.adoc b/Documentation/git-verify-pack.adoc
index d7e886918a..b0462d8db3 100644
--- a/Documentation/git-verify-pack.adoc
+++ b/Documentation/git-verify-pack.adoc
@@ -8,43 +8,39 @@ git-verify-pack - Validate packed Git archive files
SYNOPSIS
--------
-[verse]
-'git verify-pack' [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...
+[synopsis]
+git verify-pack [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...
DESCRIPTION
-----------
-Reads given idx file for packed Git archive created with the
-'git pack-objects' command and verifies the idx file and the
-corresponding pack file.
+Read each idx file for packed Git archive given on the command line,
+and verify the idx file and the corresponding pack file.
OPTIONS
-------
-<pack>.idx ...::
- The idx files to verify.
-
--v::
---verbose::
+`-v`::
+`--verbose`::
After verifying the pack, show the list of objects contained
in the pack and a histogram of delta chain length.
--s::
---stat-only::
+`-s`::
+`--stat-only`::
Do not verify the pack contents; only show the histogram of delta
chain length. With `--verbose`, the list of objects is also shown.
-\--::
+`--`::
Do not interpret any more arguments as options.
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
- 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.
diff --git a/Documentation/git-verify-tag.adoc b/Documentation/git-verify-tag.adoc
index 81d50ecc4c..ec995323f6 100644
--- a/Documentation/git-verify-tag.adoc
+++ b/Documentation/git-verify-tag.adoc
@@ -7,26 +7,24 @@ git-verify-tag - Check the GPG signature of tags
SYNOPSIS
--------
-[verse]
-'git verify-tag' [-v | --verbose] [--format=<format>] [--raw] <tag>...
+[synopsis]
+git verify-tag [-v | --verbose] [--format=<format>] [--raw] <tag>...
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
-------
---raw::
+`--raw`::
Print the raw gpg status output to standard error instead of the normal
human-readable output.
--v::
---verbose::
+`-v`::
+`--verbose`::
Print the contents of the tag object before validating it.
-<tag>...::
- SHA-1 identifiers of Git tag objects.
-
GIT
---
Part of the linkgit:git[1] suite
--
2.49.0-599-g90c2cffacf
next prev parent reply other threads:[~2025-05-01 21:34 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-01 21:34 [PATCH 0/4] A handful of doc synopsis/options update Junio C Hamano
2025-05-01 21:34 ` Junio C Hamano [this message]
2025-05-01 22:43 ` [PATCH 1/4] git-verify-* doc: update mark-up of synopsis option descriptions Eric Sunshine
2025-05-01 23:10 ` Junio C Hamano
2025-05-01 21:34 ` [PATCH 2/4] git-{var,write-tree} docs: " Junio C Hamano
2025-05-01 21:34 ` [PATCH 3/4] git-daemon doc: " Junio C Hamano
2025-05-01 22:52 ` Eric Sunshine
2025-05-01 23:12 ` Junio C Hamano
2025-05-01 23:22 ` Junio C Hamano
2025-05-01 21:34 ` [WIP PATCH 4/4] git-worktree " Junio C Hamano
2025-05-03 1:15 ` [PATCH v2 0/3] A handful of doc synopsis/options update Junio C Hamano
2025-05-03 1:15 ` [PATCH v2 1/3] git-verify-* doc: update mark-up of synopsis option descriptions Junio C Hamano
2025-05-03 1:15 ` [PATCH v2 2/3] git-{var,write-tree} docs: " Junio C Hamano
2025-05-03 1:15 ` [PATCH v2 3/3] git-daemon doc: " Junio C Hamano
2025-05-07 20:58 ` Additional changes Jean-Noël Avila
2025-05-07 20:58 ` [PATCH] " Jean-Noël Avila
2025-05-08 15:14 ` Junio C Hamano
2025-05-09 12:12 ` Jean-Noël AVILA
2025-05-09 14:35 ` Junio C Hamano
2025-05-09 17:08 ` Jean-Noël AVILA
2025-05-09 18:24 ` Junio C Hamano
2025-05-10 12:33 ` [PATCH v3 0/4] " Jean-Noël Avila
2025-05-10 12:33 ` [PATCH v3 1/4] git-daemon doc: update mark-up of synopsis option descriptions Jean-Noël Avila
2025-05-10 12:33 ` [PATCH v3 2/4] git-{var,write-tree} docs: " Jean-Noël Avila
2025-05-10 12:33 ` [PATCH v3 3/4] git-verify-* doc: " Jean-Noël Avila
2025-05-10 12:33 ` [PATCH v3 4/4] git-var doc: fix usage of $ENV_VAR vs ENV_VAR Jean-Noël Avila
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250501213414.370514-2-gitster@pobox.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.