]> git.ipfire.org Git - thirdparty/git.git/commit
doc: convert git-mv to new documentation format
authorJean-Noël Avila <jn.avila@free.fr>
Sat, 12 Apr 2025 12:20:48 +0000 (12:20 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 14 Apr 2025 21:43:52 +0000 (14:43 -0700)
commit1d5378a8c45bfcb34a7be6edde6c6159632ed9be
treebb1a395a650dc902f548c666ab7f5f025a04c080
parent8d34d3379f2946a4a2fc95802a39ea3be8a55e71
doc: convert git-mv 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.

Unfortunately, there's an inconsistency in the synopsis style, where
the ellipsis is used to indicate that the option can be repeated, but
it can also be used in Git's three-dot notation to indicate a range of
commits. The rendering engine will not be able to distinguish
between these two cases.

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