[v2,2/9] doc: split placeholders as individual tokens

Commit Message

Jean-Noël Avila Oct. 28, 2021, 4:21 p.m. UTC

From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[e-mail]>

The placeholders represent atoms of tokens and must not be
aggregates.

Signed-off-by: Jean-Noël Avila <[e-mail]>
---
 Documentation/git-archimport.txt  | 14 +++++++-------
 Documentation/git-p4.txt          |  2 +-
 Documentation/git-web--browse.txt |  2 +-
 3 files changed, 9 insertions(+), 9 deletions(-)

Comments

Martin Ågren Oct. 28, 2021, 6:45 p.m. UTC | #1

On Thu, 28 Oct 2021 at 18:22, Jean-Noël Avila via GitGitGadget
<[e-mail]> wrote:
>  archives that it imports, it is also possible to specify Git branch names
> -manually.  To do so, write a Git branch name after each <archive/branch>
> +manually.  To do so, write a Git branch name after each <archive>/<branch>
>  parameter, separated by a colon.  This way, you can shorten the Arch

> -<archive/branch>::
> -       Archive/branch identifier in a format that `tla log` understands.
> +<archive>/<branch>::
> +       <archive>/<branch> identifier in a format that `tla log` understands.

This patch looks good to me. Maybe these "<archive>/<branch>" should go
in SQs, but that should be outside the scope of this patch (and this
series is big enough anyway). This last instance here adds a new
instance of this pattern, but it's an existing pattern and you're
following the local convention.


Martin

Patch

diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt
index a595a0ffeee..847777fd172 100644
--- a/Documentation/git-archimport.txt
+++ b/Documentation/git-archimport.txt
@@ -9,14 +9,14 @@  git-archimport - Import a GNU Arch repository into Git
 SYNOPSIS
 --------
 [verse]
-'git archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir]
-               <archive/branch>[:<git-branch>] ...
+'git archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D <depth>] [-t <tempdir>]
+	       <archive>/<branch>[:<git-branch>]...
 
 DESCRIPTION
 -----------
 Imports a project from one or more GNU Arch repositories.
 It will follow branches
-and repositories within the namespaces defined by the <archive/branch>
+and repositories within the namespaces defined by the <archive>/<branch>
 parameters supplied. If it cannot find the remote branch a merge comes from
 it will just import it as a regular commit. If it can find it, it will mark it
 as a merge whenever possible (see discussion below).
@@ -27,7 +27,7 @@  import new branches within the provided roots.
 
 It expects to be dealing with one project only. If it sees
 branches that have different roots, it will refuse to run. In that case,
-edit your <archive/branch> parameters to define clearly the scope of the
+edit your <archive>/<branch> parameters to define clearly the scope of the
 import.
 
 'git archimport' uses `tla` extensively in the background to access the
@@ -42,7 +42,7 @@  incremental imports.
 
 While 'git archimport' will try to create sensible branch names for the
 archives that it imports, it is also possible to specify Git branch names
-manually.  To do so, write a Git branch name after each <archive/branch>
+manually.  To do so, write a Git branch name after each <archive>/<branch>
 parameter, separated by a colon.  This way, you can shorten the Arch
 branch names and convert Arch jargon to Git jargon, for example mapping a
 "PROJECT{litdd}devo{litdd}VERSION" branch to "master".
@@ -104,8 +104,8 @@  OPTIONS
 	Override the default tempdir.
 
 
-<archive/branch>::
-	Archive/branch identifier in a format that `tla log` understands.
+<archive>/<branch>::
+	<archive>/<branch> identifier in a format that `tla log` understands.
 
 
 GIT
diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index 38e5257b2a4..8a6addcf72f 100644
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -361,7 +361,7 @@  These options can be used to modify 'git p4 submit' behavior.
 	p4/master.  See the "Sync options" section above for more
 	information.
 
---commit <sha1>|<sha1..sha1>::
+--commit (<sha1>|<sha1>..<sha1>)::
     Submit only the specified commit or range of commits, instead of the full
     list of changes that are in the current Git branch.
 
diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt
index 8d162b56c59..f2f996cbe16 100644
--- a/Documentation/git-web--browse.txt
+++ b/Documentation/git-web--browse.txt
@@ -8,7 +8,7 @@  git-web--browse - Git helper script to launch a web browser
 SYNOPSIS
 --------
 [verse]
-'git web{litdd}browse' [<options>] <url|file>...
+'git web{litdd}browse' [<options>] (<URL>|<file>)...
 
 DESCRIPTION
 -----------