diff mbox series

[v2,5/5] doc: git-clone: do not autoreference the manpage in itself

Message ID 38bd78c92eb4ed456c6d8a471bd29658bd30c47f.1711711182.git.gitgitgadget@gmail.com (mailing list archive)
State Accepted
Commit ebb55042a4416a07c27ba45eeb24e6ff1899f360
Headers show
Series Doc new guidelines | expand

Commit Message

Jean-Noël Avila March 29, 2024, 11:19 a.m. UTC 
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>

Auto-reference in man pages is a confusion factor.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
---
 Documentation/config/clone.txt | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/config/clone.txt b/Documentation/config/clone.txt
index 71a967f262d..0a10efd174e 100644
--- a/Documentation/config/clone.txt
+++ b/Documentation/config/clone.txt
@@ -1,11 +1,21 @@ 
 `clone.defaultRemoteName`::
 	The name of the remote to create when cloning a repository.  Defaults to
-	`origin`, and can be overridden by passing the `--origin` command-line
+	`origin`.
+ifdef::git-clone[]
+	It can be overridden by passing the `--origin` command-line
+	option.
+endif::[]
+ifndef::git-clone[]
+	It can be overridden by passing the `--origin` command-line
 	option to linkgit:git-clone[1].
+endif::[]
 
 `clone.rejectShallow`::
 	Reject cloning a repository if it is a shallow one; this can be overridden by
-	passing the `--reject-shallow` option on the command line. See linkgit:git-clone[1]
+	passing the `--reject-shallow` option on the command line.
+ifndef::git-clone[]
+	See linkgit:git-clone[1].
+endif::[]
 
 `clone.filterSubmodules`::
 	If a partial clone filter is provided (see `--filter` in