From: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail•com>
To: "Jean-Noël Avila" <gitgitgadget@gmail•com>, git@vger•kernel.org
Cc: "Jean-Noël AVILA" <jn.avila@free•fr>
Subject: Re: [PATCH 2/4] doc: finalize git-clone documentation conversion to synopsis style
Date: Sun, 01 Feb 2026 13:04:13 +0100 [thread overview]
Message-ID: <6f7d027e-088a-4d66-92af-b8d1c32d730c@app.fastmail.com> (raw)
In-Reply-To: <3a5b642d05b9fcafb684631a0026959bfc362d2b.1769202903.git.gitgitgadget@gmail.com>
On Fri, Jan 23, 2026, at 22:15, Jean-Noël Avila via GitGitGadget wrote:
> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free•fr>
>
> Use backticks where appropriate for command-line options
>
> Signed-off-by: Jean-Noël Avila <jn.avila@free•fr>
> ---
> Documentation/git-clone.adoc | 22 +++++++++++-----------
> 1 file changed, 11 insertions(+), 11 deletions(-)
>
> diff --git a/Documentation/git-clone.adoc b/Documentation/git-clone.adoc
> index 57cdfb7620..7a0e147384 100644
> --- a/Documentation/git-clone.adoc
> +++ b/Documentation/git-clone.adoc
> @@ -152,7 +152,7 @@ objects from the source repository into a pack in
> the cloned repository.
> unknown ones, is server-specific.
> When multiple `--server-option=<option>` are given, they are all
> sent to the other side in the order listed on the command line.
> - When no ++--server-option=++__<option>__ is given from the command
> + When no `--server-option=<option>` is given from the command
Just using backticks now that `synopsis` style handles placeholder
rendering. Makes sense.
> line, the values of configuration variable
> `remote.<name>.serverOption`
> are used instead.
>
> @@ -206,14 +206,14 @@ objects from the source repository into a pack in
> the cloned repository.
> that all these refs are overwritten by a `git remote update` in the
> target repository.
>
> -`-o` _<name>_::
> -`--origin` _<name>_::
> +`-o <name>`::
> +`--origin <name>`::
> Instead of using the remote name `origin` to keep track of the upstream
> repository, use _<name>_. Overrides `clone.defaultRemoteName` from the
> config.
Doesn’t need to be done now in this series, but the “stuck form” of
`--origin=<name>` is recommended by gitcli(7) for long optoins. This doc
uses a mix of unstuck form (no `=`) and stuck form.
>
> -`-b` _<name>_::
> -`--branch` _<name>_::
> +`-b <name>`::
> +`--branch <name>`::
> Instead of pointing the newly created `HEAD` to the branch pointed
> to by the cloned repository's `HEAD`, point to _<name>_ branch
> instead. In a non-bare repository, this is the branch that will
> @@ -230,8 +230,8 @@ objects from the source repository into a pack in
> the cloned repository.
> name.
> This option is incompatible with `--branch` and `--mirror`.
>
> -`-u` _<upload-pack>_::
> -`--upload-pack` _<upload-pack>_::
> +`-u <upload-pack>`::
> +`--upload-pack <upload-pack>`::
> When given, and the repository to clone from is accessed
> via ssh, this specifies a non-default path for the command
> run on the other end.
> @@ -240,8 +240,8 @@ objects from the source repository into a pack in
> the cloned repository.
> Specify the directory from which templates will be used;
> (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
Looks good. Just same comments.
>
> -`-c` `<key>=<value>`::
> -`--config` `<key>=<value>`::
> +`-c <key>=<value>`::
> +`--config <key>=<value>`::
> Set a configuration variable in the newly-created repository;
> this takes effect immediately after the repository is
> initialized, but before the remote history is fetched or any
I was curious if you can use `--config=<key>=<value>` without tripping
up the option parser. And you can:
git clone --config=core.editor=something ...
> @@ -339,8 +339,8 @@ Specify the given ref storage format for the
> repository. The valid values are:
> +
> include::ref-storage-format.adoc[]
>
> -`-j` _<n>_::
> -`--jobs` _<n>_::
> +`-j <n>`::
> +`--jobs <n>`::
> The number of submodules fetched at the same time.
> Defaults to the `submodule.fetchJobs` option.
>
Good.
> --
> gitgitgadget
next prev parent reply other threads:[~2026-02-01 12:04 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-23 21:14 [PATCH 0/4] doc: some more synopsis conversions and fixes Jean-Noël Avila via GitGitGadget
2026-01-23 21:15 ` [PATCH 1/4] convert git-submodule doc to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-01 12:04 ` Kristoffer Haugsbakk
2026-01-23 21:15 ` [PATCH 2/4] doc: finalize git-clone documentation conversion " Jean-Noël Avila via GitGitGadget
2026-02-01 12:04 ` Kristoffer Haugsbakk [this message]
2026-02-01 13:14 ` Jean-Noël AVILA
2026-02-02 8:36 ` Kristoffer Haugsbakk
2026-01-23 21:15 ` [PATCH 3/4] doc: fix some style issues in git-clone and for-each-ref-options Jean-Noël Avila via GitGitGadget
2026-02-01 12:11 ` Kristoffer Haugsbakk
2026-01-23 21:15 ` [PATCH 4/4] doc: convert git-show to synopsis style Jean-Noël Avila via GitGitGadget
2026-01-25 19:27 ` Kristoffer Haugsbakk
2026-01-25 21:11 ` Jean-Noël AVILA
2026-01-26 5:58 ` Kristoffer Haugsbakk
2026-01-26 21:25 ` [PATCH v2 0/4] doc: some more synopsis conversions and fixes Jean-Noël Avila via GitGitGadget
2026-01-26 21:25 ` [PATCH v2 1/4] convert git-submodule doc to synopsis style Jean-Noël Avila via GitGitGadget
2026-01-26 21:25 ` [PATCH v2 2/4] doc: finalize git-clone documentation conversion " Jean-Noël Avila via GitGitGadget
2026-01-26 21:25 ` [PATCH v2 3/4] doc: fix some style issues in git-clone and for-each-ref-options Jean-Noël Avila via GitGitGadget
2026-01-26 21:25 ` [PATCH v2 4/4] doc: convert git-show to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-01 12:12 ` Kristoffer Haugsbakk
2026-02-01 16:39 ` Jean-Noël AVILA
2026-02-03 17:03 ` [PATCH v3 0/4] doc: some more synopsis conversions and fixes Jean-Noël Avila via GitGitGadget
2026-02-03 17:03 ` [PATCH v3 1/4] doc: convert git-submodule to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-03 21:45 ` Kristoffer Haugsbakk
2026-02-06 3:55 ` Jean-Noël Avila
2026-02-03 17:03 ` [PATCH v3 2/4] doc: finalize git-clone documentation conversion " Jean-Noël Avila via GitGitGadget
2026-02-03 21:45 ` Kristoffer Haugsbakk
2026-02-03 17:03 ` [PATCH v3 3/4] doc: fix some style issues in git-clone and for-each-ref-options Jean-Noël Avila via GitGitGadget
2026-02-03 21:46 ` Kristoffer Haugsbakk
2026-02-03 17:03 ` [PATCH v3 4/4] doc: convert git-show to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-03 21:44 ` Kristoffer Haugsbakk
2026-02-03 21:44 ` [PATCH v3 0/4] doc: some more synopsis conversions and fixes Kristoffer Haugsbakk
2026-02-04 16:24 ` Kristoffer Haugsbakk
2026-02-06 4:12 ` [PATCH v4 " Jean-Noël Avila via GitGitGadget
2026-02-06 4:12 ` [PATCH v4 1/4] doc: convert git-submodule to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-06 4:12 ` [PATCH v4 2/4] doc: finalize git-clone documentation conversion " Jean-Noël Avila via GitGitGadget
2026-02-06 4:12 ` [PATCH v4 3/4] doc: fix some style issues in git-clone and for-each-ref-options Jean-Noël Avila via GitGitGadget
2026-02-06 4:12 ` [PATCH v4 4/4] doc: convert git-show to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-07 14:24 ` [PATCH v4 0/4] doc: some more synopsis conversions and fixes Kristoffer Haugsbakk
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=6f7d027e-088a-4d66-92af-b8d1c32d730c@app.fastmail.com \
--to=kristofferhaugsbakk@fastmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitgitgadget@gmail$(echo .)com \
--cc=jn.avila@free$(echo .)fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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