]> git.ipfire.org Git - thirdparty/git.git/commit
doc: convert git-restore to new style format
authorJean-Noël Avila <jn.avila@free.fr>
Fri, 10 Jan 2025 10:09:19 +0000 (10:09 +0000)
committerJunio C Hamano <gitster@pobox.com>
Fri, 10 Jan 2025 23:21:21 +0000 (15:21 -0800)
commit69666e6746e4e87535ebf89c463980a9c655bae7
tree562ee24bc563ed67cf3d98cde6a0347cda9e2701
parent1b4e9a5f8b5f048972c21fe8acafe0404096f694
doc: convert git-restore to new style format

- 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.

While at it, also convert an option description to imperative mood.

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