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

[PATCH v2 5/5] git-wortkree.txt: link to man pages when citing other Git commands

From
Eric Sunshine <sunshine@sunshineco.com>
Date
Aug 4, 2020, 00:55 UTC
Message-ID
<20200804005535.5126-6-sunshine@sunshineco.com>
In-Reply-To
<20200804005535.5126-1-sunshine@sunshineco.com>

When citing other Git commands, rather than merely formatting them with a fixed-width typeface, improve the reader experience by linking to them directly via `linkgit:`.

Suggested-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
 Documentation/git-worktree.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 544464f949..6ee6ec7982 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -25,8 +25,9 @@ Manage multiple working trees attached to the same repository.
 A git repository can support multiple working trees, allowing you to check
 out more than one branch at a time.  With `git worktree add` a new working
 tree is associated with the repository.  This new working tree is called a
-"linked working tree" as opposed to the "main working tree" prepared by `git
-init` or `git clone`.  A repository has one main working tree (if it's not a
+"linked working tree" as opposed to the "main working tree" prepared by
+linkgit:git-init[1] or linkgit:git-clone[1].
+A repository has one main working tree (if it's not a
 bare repository) and zero or more linked working trees. When you are done
 with a linked working tree, remove it with `git worktree remove`.
 
-- 
2.28.0.236.gb10cc79966
Previous: Eric SunshineNext: Eric Sunshine
Message 15 of 20 in “git-worktree documentation cleanups”
  1. 0/4 git-worktree documentation cleanupsEric Sunshine, Aug 3, 2020
  2. 2/4 git-worktree.txt: consistently use term "working tree"Eric Sunshine, Aug 3, 2020
  3. 1/4 git-worktree.txt: employ fixed-width typeface consistentlyEric Sunshine, Aug 3, 2020
  4. 3/4 git-worktree.txt: fix minor grammatical issuesEric Sunshine, Aug 3, 2020
  5. 4/4 git-worktree.txt: make start of new sentence more obviousEric Sunshine, Aug 3, 2020
  6. Taylor BlauAug 3, 2020
  7. Junio C HamanoAug 3, 2020
  8. Martin ÅgrenAug 3, 2020
  9. Eric SunshineAug 3, 2020
  10. Junio C HamanoAug 4, 2020
  11. 0/5 git-worktree documentation cleanupsEric Sunshine, Aug 4, 2020
  12. 3/5 git-worktree.txt: fix minor grammatical issuesEric Sunshine, Aug 4, 2020
  13. 1/5 git-worktree.txt: employ fixed-width typeface consistentlyEric Sunshine, Aug 4, 2020
  14. 4/5 git-worktree.txt: make start of new sentence more obviousEric Sunshine, Aug 4, 2020
  15. 5/5 git-wortkree.txt: link to man pages when citing other Git commandsEric Sunshine, Aug 4, 2020
  16. 2/5 git-worktree.txt: consistently use term "working tree"Eric Sunshine, Aug 4, 2020
  17. Taylor BlauAug 4, 2020
  18. Martin ÅgrenAug 4, 2020
  19. Eric SunshineAug 4, 2020
  20. Martin ÅgrenAug 4, 2020

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.