]> git.ipfire.org Git - thirdparty/git.git/commit
doc: patch-id: convert to the modern synopsis style
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Mon, 13 Oct 2025 15:42:15 +0000 (17:42 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 13 Oct 2025 15:53:13 +0000 (08:53 -0700)
commit8f487db07aa16e026fde0e3d11e4fbf31ab15636
tree4816d9f1c225040deafdf9e6827b264893e38f55
parente8239f302f3690ff452c832c352d5bdccd9d6662
doc: patch-id: convert to the modern synopsis style

Convert this command documentation to the modern synopsis style based on
similar work.[1] Concretely:

• Change the Synopsis section from `verse` to a `synopsis` block which
  will automatically apply the correct formatting to various elements
  (although this Synopsis is very simple)
• Use backticks (`) for code-like things which will also use the correct
  formatting for interior placeholders (`<orderfile>`)
• Use inline-verbatim on options listing

† 1: E.g.,
     • 026f2e3b (doc: convert git-log to new documentation format,
       2025-07-07)
     • b983aaab (doc: convert git-switch manpage to new synopsis style,
       2025-05-25)
     • 16543967 (doc: convert git-mergetool manpage to new synopsis
       style, 2025-05-25)

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-patch-id.adoc