]> git.ipfire.org Git - thirdparty/git.git/commit
doc: git-diff: apply new documentation guidelines
authorJean-Noël Avila <jn.avila@free.fr>
Mon, 18 Nov 2024 22:05:49 +0000 (22:05 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 19 Nov 2024 03:31:04 +0000 (12:31 +0900)
commite72c2d2e913049e144e7fd4459238d237ba0baf8
treebdda29d829750f94f9c064296497a5a90d990121
parentb31fb630c0fc6869a33ed717163e8a1210460d94
doc: git-diff: apply new documentation guidelines

The documentation for git-diff has been updated to follow the new
documentation guidelines. The following changes have been applied to
the series of patches:

- switching 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.
- prevent git-diff from self-referencing itself via gitlink macro when
the generated link would point to the same page.

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