git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Jean-Noël Avila" <jn.avila@free.fr>,
	"Jean-Noël Avila" <jn.avila@free.fr>
Subject: [PATCH 5/5] doc: convert git-mv to new documentation format
Date: Sun, 30 Mar 2025 17:16:04 +0000	[thread overview]
Message-ID: <4887567c57cd54b8f5989d1d05a9a7a9663665b1.1743354964.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1896.git.1743354964.gitgitgadget@gmail.com>

From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>

- 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>
---
 Documentation/git-mv.adoc | 31 ++++++++++++++++---------------
 1 file changed, 16 insertions(+), 15 deletions(-)

diff --git a/Documentation/git-mv.adoc b/Documentation/git-mv.adoc
index 08d660643fc..a0b8118cf4f 100644
--- a/Documentation/git-mv.adoc
+++ b/Documentation/git-mv.adoc
@@ -8,17 +8,18 @@ git-mv - Move or rename a file, a directory, or a symlink
 
 SYNOPSIS
 --------
-[verse]
-'git mv' [-v] [-f] [-n] [-k] <source> <destination>
-'git mv' [-v] [-f] [-n] [-k] <source> ... <destination-directory>
+
+[synopsis]
+git mv [-v] [-f] [-n] [-k] <source> <destination>
+git mv [-v] [-f] [-n] [-k] <source> ... <destination-directory>
 
 DESCRIPTION
 -----------
 Move or rename a file, directory, or symlink.
 
-In the first form, it renames <source>, which must exist and be either
-a file, symlink or directory, to <destination>.
-In the second form, the last argument has to be an existing
+In the first form, it renames _<source>_, which must exist and be either
+a file, symlink or directory, to _<destination>_.
+In the second form, _<destination-directory>_ has to be an existing
 directory; the given sources will be moved into this directory.
 
 The index is updated after successful completion, but the change must still be
@@ -26,20 +27,20 @@ committed.
 
 OPTIONS
 -------
--f::
---force::
+`-f`::
+`--force`::
 	Force renaming or moving of a file even if the <destination> exists.
--k::
+`-k`::
 	Skip move or rename actions which would lead to an error
 	condition. An error happens when a source is neither existing nor
 	controlled by Git, or when it would overwrite an existing
 	file unless `-f` is given.
--n::
---dry-run::
+`-n`::
+`--dry-run`::
 	Do nothing; only show what would happen
 
--v::
---verbose::
+`-v`::
+`--verbose`::
 	Report the names of files as they are moved.
 
 SUBMODULES
@@ -47,8 +48,8 @@ SUBMODULES
 Moving a submodule using a gitfile (which means they were cloned
 with a Git version 1.7.8 or newer) will update the gitfile and
 core.worktree setting to make the submodule work in the new location.
-It also will attempt to update the submodule.<name>.path setting in
-the linkgit:gitmodules[5] file and stage that file (unless -n is used).
+It also will attempt to update the `submodule.<name>.path` setting in
+the linkgit:gitmodules[5] file and stage that file (unless `-n` is used).
 
 BUGS
 ----
-- 
gitgitgadget

  parent reply	other threads:[~2025-03-30 17:16 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-03-30 17:15 [PATCH 0/5] doc: convert git-reset, git-rm and git-mv to new documentation format Jean-Noël Avila via GitGitGadget
2025-03-30 17:16 ` [PATCH 1/5] doc: convert git-reset " Jean-Noël Avila via GitGitGadget
2025-04-04 16:39   ` Martin Ågren
2025-03-30 17:16 ` [PATCH 2/5] doc: fix synopsis analysis logic Jean-Noël Avila via GitGitGadget
2025-04-04 16:39   ` Martin Ågren
2025-04-12  8:58     ` Jean-Noël Avila
2025-03-30 17:16 ` [PATCH 3/5] doc: convert git-rm to new documentation format Jean-Noël Avila via GitGitGadget
2025-03-30 17:16 ` [PATCH 4/5] doc: move synopsis git-mv commands in the synopsis section Jean-Noël Avila via GitGitGadget
2025-04-05 10:57   ` Martin Ågren
2025-03-30 17:16 ` Jean-Noël Avila via GitGitGadget [this message]
2025-04-12 12:20 ` [PATCH v2 0/7] doc: convert git-reset, git-rm and git-mv to new documentation format Jean-Noël Avila via GitGitGadget
2025-04-12 12:20   ` [PATCH v2 1/7] doc: convert git-reset " Jean-Noël Avila via GitGitGadget
2025-04-12 12:20   ` [PATCH v2 2/7] doc: fix synopsis analysis logic Jean-Noël Avila via GitGitGadget
2025-04-12 12:20   ` [PATCH v2 3/7] doc: convert git-rm to new documentation format Jean-Noël Avila via GitGitGadget
2025-04-12 12:20   ` [PATCH v2 4/7] doc: move synopsis git-mv commands in the synopsis section Jean-Noël Avila via GitGitGadget
2025-04-12 12:20   ` [PATCH v2 5/7] doc: convert git-mv to new documentation format Jean-Noël Avila via GitGitGadget
2025-04-12 12:20   ` [PATCH v2 6/7] doc: fix asciidoctor synopsis processing of triple-dots Jean-Noël Avila via GitGitGadget
2025-04-12 12:20   ` [PATCH v2 7/7] doc: add markup for characters in Guidelines Jean-Noël Avila via GitGitGadget
2025-04-14 21:47   ` [PATCH v2 0/7] doc: convert git-reset, git-rm and git-mv to new documentation format Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4887567c57cd54b8f5989d1d05a9a7a9663665b1.1743354964.git.gitgitgadget@gmail.com \
    --to=gitgitgadget@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=jn.avila@free.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).