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

[PATCH 0/3] worktree: add -d shorthand for --detach & improve documentation

From
Eric Sunshine <sunshine@sunshineco.com>
Date
Sep 4, 2020, 07:07 UTC
Message-ID
<20200904070703.47898-1-sunshine@sunshineco.com>

This series grew directly out of suggestions proposed in [1]. Its purpose is twofold. First, it brings git-worktree in line with the other "checkout a branch" commands git-switch and git-checkout by teaching it -d as shorthand for --detach (which those other commands already understand). Second, it enhances git-worktree documentation to emphasize that `git worktree add <path>` creates a new branch by default, and to discuss branch-based vs. throwaway worktrees, which may help newcomers avoid creating unwanted new branches without realizing they are doing, and later wondering why `git branch --list` shows branches they did not intentionally create.

There was an earlier attempt[2] by Pratyush to add -d as shorthand for --detach (though it did not enhance git-worktree documentation as the current patch series does), however, that patch was never re-rolled after reviewers pushed back on a few of the changes it made.

[1]: https://lore.kernel.org/git/CAPig+cQmqKiYWDWFH5eK2S6XPOi2t2+8Oas8yZa8R=bKLym3wQ@mail.gmail.com/ [2]: https://lore.kernel.org/git/20200125173744.4334-1-me@yadavpratyush.com/

Eric Sunshine (3):
  git-checkout.txt: document -d short option for --detach
  worktree: add -d short option for --detach
  git-worktree.txt: discuss branch-based vs. throwaway worktrees
 Documentation/git-checkout.txt |  1 +
 Documentation/git-worktree.txt | 13 +++++++++++++
 builtin/worktree.c             |  2 +-
 3 files changed, 15 insertions(+), 1 deletion(-)
-- 
2.28.0.618.gf4bc123cb7
Next: Eric Sunshine
Message 1 of 9 in “worktree: add -d shorthand for --detach & improve documentation”
  1. 0/3 worktree: add -d shorthand for --detach & improve documentationEric Sunshine, Sep 4, 2020
  2. 2/3 worktree: add -d short option for --detachEric Sunshine, Sep 4, 2020
  3. 1/3 git-checkout.txt: document -d short option for --detachEric Sunshine, Sep 4, 2020
  4. 3/3 git-worktree.txt: discuss branch-based vs. throwaway worktreesEric Sunshine, Sep 4, 2020
  5. Junio C HamanoSep 6, 2020
  6. 0/3 worktree: teach `add` -d for --detach & improve documentationEric Sunshine, Sep 7, 2020
  7. 2/3 worktree: teach `add` to recognize -d as shorthand for --detachEric Sunshine, Sep 7, 2020
  8. 1/3 git-checkout.txt: document -d short option for --detachEric Sunshine, Sep 7, 2020
  9. 3/3 git-worktree.txt: discuss branch-based vs. throwaway worktreesEric Sunshine, Sep 7, 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.