]> git.ipfire.org Git - thirdparty/git.git/commit
doc: convert git-remote to synopsis style
authorJean-Noël Avila <jn.avila@free.fr>
Sat, 20 Dec 2025 19:16:27 +0000 (19:16 +0000)
committerJunio C Hamano <gitster@pobox.com>
Sun, 21 Dec 2025 02:33:10 +0000 (11:33 +0900)
commitacffc5e9e54f5632abefe53d0914007709d409ce
tree13e5dbd2f35591c035b5a065d5b8fa505019c586
parent5b35e736ddc5b1cad4a4e5e18a546b2f9c8f80d3
doc: convert git-remote to synopsis style

- Switch the synopsis to a synopsis block which will automatically
  format placeholders in italics and keywords in monospace
- Use _<placeholder>_ instead of <placeholder> in the description
- Use `backticks` for keywords and more complex option
descriptions. The new rendering engine will apply synopsis rules to
these spans.
- also convert first sentences to imperative mood where applicable

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-remote.adoc