]> git.ipfire.org Git - thirdparty/git.git/commit
projects / thirdparty / git.git / commit
? search:
summary | shortlog | log | commit | commitdiff | tree
(parent: 757161e) | patch
doc: apply new documentation guidelines to git commit
authorJean-Noël Avila <jn.avila@free.fr>
Wed, 15 Jan 2025 20:23:44 +0000 (20:23 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 15 Jan 2025 22:43:36 +0000 (14:43 -0800)
commitbe2ea674ccb2492de9cb9a5d55b88396001eda2d
tree0f4e8b86f8c15d5a29639c86225f549ddc2bb782tree | snapshot
parent757161efcca150a9a96b312d9e780a071e601a03commit | diff
doc: apply new documentation guidelines to git commit

- 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/git-commit.txt diff | blob | blame | history
Unnamed repository; edit this file 'description' to name the repository.