]> git.ipfire.org Git - thirdparty/git.git/commit
doc: git-log: convert pretty formats to new doc format
authorJean-Noël Avila <jn.avila@free.fr>
Mon, 7 Jul 2025 18:53:30 +0000 (18:53 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 7 Jul 2025 20:45:00 +0000 (13:45 -0700)
commitca484a90e27c79083ecca3adf2bc8d3c42a5f006
tree217260228d9cc921503de05e6d0ede69f7c5d504
parent06db6a3c4a9e23e575f9e5e7f812358deaf11834
doc: git-log: convert pretty formats to new doc format

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

For all the formats in the form of %(foo), the formatting needs to be
heavier because we not want the parentheses to be rendered as syntax
elements,but as keywords, i.e. we need to circumvent the syntax highlighting
of synopsis.  In this particular case, this requires the heavy escaping of
the parts that contain parentheses with ++.

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