git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Jean-Noël Avila via GitGitGadget <gitgitgadget@gmail.com>
Date
Mar 29, 2024, 11:19 UTC
Message-ID
<38bd78c92eb4ed456c6d8a471bd29658bd30c47f.1711711182.git.gitgitgadget@gmail.com>
In-Reply-To
<pull.1702.v2.git.1711711181.gitgitgadget@gmail.com>
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 --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
-- 
gitgitgadget
Previous: Jean-Noël Avila via GitGitGadgetNext: Jean-Noël Avila via GitGitGadget
Message 20 of 21 in “Doc new guidelines”
  1. 0/4 Doc new guidelinesJean-Noël Avila via GitGitGadget, Mar 24, 2024
  2. 1/4 doc: rework CodingGuidelines with new formatting rulesJean-Noël Avila via GitGitGadget, Mar 24, 2024
  3. 2/4 doc: allow literal and emphasis format in doc vs help testsJean-Noël Avila via GitGitGadget, Mar 24, 2024
  4. Jeff KingMar 28, 2024
  5. Eric SunshineMar 28, 2024
  6. 3/4 doc: git-init: apply new documentation formatting guidelinesJean-Noël Avila via GitGitGadget, Mar 24, 2024
  7. Martin ÅgrenMar 26, 2024
  8. Jean-Noël AVILAMar 26, 2024
  9. 4/4 doc: git-clone: apply new documentation guidelinesJean-Noël Avila via GitGitGadget, Mar 24, 2024
  10. Martin ÅgrenMar 26, 2024
  11. Junio C HamanoMar 26, 2024
  12. Jean-Noël AVILAMar 26, 2024
  13. Junio C HamanoMar 26, 2024
  14. 0/5 Doc new guidelinesJean-Noël Avila via GitGitGadget, Mar 29, 2024
  15. 1/5 doc: rework CodingGuidelines with new formatting rulesJean-Noël Avila via GitGitGadget, Mar 29, 2024
  16. Eric SunshineMar 29, 2024
  17. Jean-Noël AVILAMar 30, 2024
  18. 2/5 doc: allow literal and emphasis format in doc vs help testsJean-Noël Avila via GitGitGadget, Mar 29, 2024
  19. 3/5 doc: git-init: apply new documentation formatting guidelinesJean-Noël Avila via GitGitGadget, Mar 29, 2024
  20. 5/5 doc: git-clone: do not autoreference the manpage in itselfJean-Noël Avila via GitGitGadget, Mar 29, 2024
  21. 4/5 doc: git-clone: apply new documentation formatting guidelinesJean-Noël Avila via GitGitGadget, Mar 29, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.