]> git.ipfire.org Git - thirdparty/git.git/commit
git-verify-* doc: update mark-up of synopsis option descriptions
authorJunio C Hamano <gitster@pobox.com>
Sat, 10 May 2025 12:33:16 +0000 (14:33 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 12 May 2025 16:25:27 +0000 (09:25 -0700)
commit7e7f47a48853a520db606bcd2269bb17cba09744
treed70a79510f58a6f0c74ed1634db2cdcc5796d80b
parent914c549ac161c3393dd760be5af4d290620a27e8
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>
Documentation/git-verify-commit.adoc
Documentation/git-verify-pack.adoc
Documentation/git-verify-tag.adoc