From 7e7f47a48853a520db606bcd2269bb17cba09744 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sat, 10 May 2025 14:33:16 +0200 Subject: git-verify-* doc: update mark-up of synopsis option descriptions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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=` in backquotes * do not describe non-option arguments in the OPTIONS section Signed-off-by: Junio C Hamano Helped-by: Jean-Noël Avila Signed-off-by: Junio C Hamano --- Documentation/git-verify-commit.adoc | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) (limited to 'Documentation/git-verify-commit.adoc') 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] ... +[synopsis] +git verify-commit [-v | --verbose] [--raw] ... 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. -...:: - SHA-1 identifiers of Git commit objects. - GIT --- Part of the linkgit:git[1] suite -- cgit v1.2.3