]> git.ipfire.org Git - thirdparty/git.git/commit
doc: convert git-notes to new documentation format
authorJean-Noël Avila <jn.avila@free.fr>
Fri, 10 Jan 2025 10:08:23 +0000 (10:08 +0000)
committerJunio C Hamano <gitster@pobox.com>
Fri, 10 Jan 2025 23:19:52 +0000 (15:19 -0800)
commit77b2d29e91c568dc3b08adbfc48fea641d4e39f7
tree03ec471c5c615d14083dc3d1451afbdc6d706acc
parent1b4e9a5f8b5f048972c21fe8acafe0404096f694
doc: convert git-notes 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.

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