From 2af8dc9b2a2e84b32b74aae808c92c09f85fa91e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= Date: Fri, 23 Jan 2026 21:15:02 +0000 Subject: [PATCH] doc: fix some style issues in git-clone and for-each-ref-options MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * spell out all forms of --[no-]reject-shallow in git-clone * use imperative mood for the first line of options * Use asciidoc NOTE macro * fix markups Signed-off-by: Jean-Noël Avila Signed-off-by: Junio C Hamano --- Documentation/for-each-ref-options.adoc | 4 ++-- Documentation/git-clone.adoc | 30 ++++++++++++------------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/Documentation/for-each-ref-options.adoc b/Documentation/for-each-ref-options.adoc index f13efb5f25..54e2fa95c2 100644 --- a/Documentation/for-each-ref-options.adoc +++ b/Documentation/for-each-ref-options.adoc @@ -30,8 +30,8 @@ TAB %(refname)`. `--color[=]`:: Respect any colors specified in the `--format` option. The - _` is absent, behave as if `always` was given). + __ field must be one of `always`, `never`, or `auto` (if + __ is absent, behave as if `always` was given). `--shell`:: `--perl`:: diff --git a/Documentation/git-clone.adoc b/Documentation/git-clone.adoc index 7a0e147384..fceeb43475 100644 --- a/Documentation/git-clone.adoc +++ b/Documentation/git-clone.adoc @@ -84,7 +84,7 @@ __. with the source repository. The resulting repository starts out without any object of its own. + -*NOTE*: this is a possibly dangerous operation; do *not* use +NOTE: this is a possibly dangerous operation; do *not* use it unless you understand what it does. If you clone your repository using this option and then delete branches (or use any other Git command that makes any existing commit unreferenced) in the @@ -104,7 +104,8 @@ If you want to break the dependency of a repository cloned with `--shared` on its source repository, you can simply run `git repack -a` to copy all objects from the source repository into a pack in the cloned repository. -`--reference[-if-able] `:: +`--reference `:: +`--reference-if-able `:: If the reference __ is on the local machine, automatically setup `.git/objects/info/alternates` to obtain objects from the reference __. Using @@ -115,7 +116,7 @@ objects from the source repository into a pack in the cloned repository. directory is skipped with a warning instead of aborting the clone. + -*NOTE*: see the NOTE for the `--shared` option, and also the +NOTE: see the NOTE for the `--shared` option, and also the `--dissociate` option. `--dissociate`:: @@ -140,14 +141,14 @@ objects from the source repository into a pack in the cloned repository. to the standard error stream. `--progress`:: - Progress status is reported on the standard error stream - by default when it is attached to a terminal, unless `--quiet` + Report progress status on the standard error stream + by default when attached to a terminal, unless `--quiet` is specified. This flag forces progress status even if the standard error stream is not directed to a terminal. `--server-option=