Re: [PATCH 2/4] doc: finalize git-clone documentation conversion to synopsis style

From: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
Date: Feb 1, 2026, 12:04 UTC
Message-ID: <6f7d027e-088a-4d66-92af-b8d1c32d730c@app.fastmail.com>
In-Reply-To: <3a5b642d05b9fcafb684631a0026959bfc362d2b.1769202903.git.gitgitgadget@gmail.com>

On Fri, Jan 23, 2026, at 22:15, Jean-Noël Avila via GitGitGadget wrote:

Show 20 quoted lines

> 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.

Show 16 quoted lines

>  	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.

Show 24 quoted lines

>
> -`-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.

Show 8 quoted lines

>
> -`-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 ...

Show 12 quoted lines

> @@ -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