]> git.ipfire.org Git - thirdparty/git.git/commit
doc: convert git-log to new documentation format
authorJean-Noël Avila <jn.avila@free.fr>
Mon, 7 Jul 2025 18:53:24 +0000 (18:53 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 7 Jul 2025 20:45:00 +0000 (13:45 -0700)
commit026f2e3be23b2e5f227e1973b480481a1d48f6a6
tree82ab5fcfcfe846c99a6e480a814bf0e2f41e586d
parent16bd9f20a403117f2e0d9bcda6c6e621d3763e77
doc: convert git-log to new documentation 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.

We also transform inline descriptions of possible values of option
--decorate into a list, which is more readable and extensible.

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