git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Michal Suchanek <msuchanek@suse.de>
To: git@vger.kernel.org
Cc: Michal Suchanek <msuchanek@suse.de>,
	Junio C Hamano <gitster@pobox.com>,
	Eric Sunshine <sunshine@sunshineco.com>,
	Sergey Organov <sorganov@gmail.com>,
	Ben Knoble <ben.knoble@gmail.com>,
	Jason Cho <jason11choca@proton.me>,
	"Jakub T. Jankiewicz" <jcubic@jcubic.pl>
Subject: [PATCH 1/2] doc: git-worktree: Link to examples
Date: Thu,  2 Oct 2025 17:51:34 +0200	[thread overview]
Message-ID: <a203b35538847f3c9358a5ae26fb4ebea5734cfc.1759420102.git.msuchanek@suse.de> (raw)
In-Reply-To: <xmqqseg1xwc1.fsf@gitster.g>

Also add advice to put new worktrees outside of existing ones.

Signed-off-by: Michal Suchanek <msuchanek@suse.de>
---
 Documentation/git-worktree.adoc | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-worktree.adoc b/Documentation/git-worktree.adoc
index 389e669ac0..ec31863aec 100644
--- a/Documentation/git-worktree.adoc
+++ b/Documentation/git-worktree.adoc
@@ -79,6 +79,9 @@ with a matching name, treat as equivalent to:
 $ git worktree add --track -b <branch> <path> <remote>/<branch>
 ------------
 +
+For best results it is advised to specify <path> outside of the repository and
+existing worktrees - see <<EXAMPLES>>
++
 If the branch exists in multiple remotes and one of them is named by
 the `checkout.defaultRemote` configuration variable, we'll use that
 one for the purposes of disambiguation, even if the `<branch>` isn't
@@ -502,8 +505,8 @@ locked "reason\nwhy is locked"
 ...
 ------------
 
-EXAMPLES
---------
+[[EXAMPLES]]EXAMPLES
+--------------------
 You are in the middle of a refactoring session and your boss comes in and
 demands that you fix something immediately. You might typically use
 linkgit:git-stash[1] to store your changes away temporarily, however, your
-- 
2.51.0



  reply	other threads:[~2025-10-02 15:52 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-27 13:28 What is the reason behind not hiding git worktrees from git? Jakub T. Jankiewicz
2025-09-27 16:52 ` Junio C Hamano
2025-09-27 17:55   ` Michal Suchánek
2025-09-27 21:08     ` Jason Cho
2025-09-27 21:26       ` Jason Cho
2025-09-30 10:30         ` Michal Suchánek
2025-09-30 15:47           ` Junio C Hamano
2025-11-19  8:13             ` Michal Suchánek
2025-09-30 10:37       ` Michal Suchánek
2025-10-01 12:16         ` Ben Knoble
2025-10-01 18:54           ` Junio C Hamano
2025-10-01 20:22             ` Sergey Organov
2025-10-01 20:48               ` Junio C Hamano
2025-10-01 21:27                 ` Jakub T. Jankiewicz
2025-10-01 22:07                   ` Junio C Hamano
2025-10-01 21:29                 ` Eric Sunshine
2025-10-01 22:27                   ` Junio C Hamano
2025-10-02  8:38                     ` Michal Suchánek
2025-10-02 13:33                       ` Junio C Hamano
2025-10-02 15:51                         ` Michal Suchanek [this message]
2025-10-02 17:42                           ` [PATCH 1/2] doc: git-worktree: Link to examples Kristoffer Haugsbakk
2025-10-02 17:44                           ` Junio C Hamano
2025-10-02 18:55                             ` Michal Suchánek
2025-10-05 20:52                           ` Jean-Noël AVILA
2025-10-10 17:10                             ` Michal Suchánek
2025-10-10 17:04                           ` [PATCH v2 " Michal Suchanek
2025-10-11  4:40                             ` Eric Sunshine
2025-10-10 17:04                           ` [PATCH v2 2/2] doc: git-worktree: Add side by side branch checkout example Michal Suchanek
2025-10-11  5:17                             ` Eric Sunshine
2025-10-23 19:40                               ` Junio C Hamano
2025-10-24 10:15                               ` Michal Suchánek
2025-10-24 16:57                                 ` Eric Sunshine
2025-11-18 12:01                                   ` Michal Suchánek
2025-11-19  7:19                                     ` Eric Sunshine
2025-10-02 15:51                         ` [PATCH " Michal Suchanek
2025-10-02 17:51                           ` Kristoffer Haugsbakk
2025-10-02 18:46                             ` Michal Suchánek
2025-10-02 18:47                             ` Junio C Hamano
2025-10-02 18:06                           ` Junio C Hamano
2025-10-02 18:39                             ` Michal Suchánek
2025-11-17 22:36                   ` What is the reason behind not hiding git worktrees from git? Johannes Schindelin
2025-11-17 22:57                     ` Junio C Hamano
2025-10-02  2:33             ` Ben Knoble

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=a203b35538847f3c9358a5ae26fb4ebea5734cfc.1759420102.git.msuchanek@suse.de \
    --to=msuchanek@suse.de \
    --cc=ben.knoble@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jason11choca@proton.me \
    --cc=jcubic@jcubic.pl \
    --cc=sorganov@gmail.com \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).