All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: Git Mailing list <git@vger.kernel.org>
Subject: man page for "git-worktree" is a bit confusing WRT "prune"
Date: Mon, 13 Nov 2017 09:48:36 -0500 (EST)	[thread overview]
Message-ID: <alpine.LFD.2.21.1711130938080.5262@DESKTOP-1GPMCEJ> (raw)


  once more, into the man pages ... "git worktree" seems like a fairly
simple command, but there is some confusion about the function of

  $ git worktree prune

the normal meaning of "prune" (certainly with git commands) is to
actually delete some content, and the initial impression of this
command is that it will delete an actual worktree. however, further
reading reveals:

" ... or you can run git worktree prune in the main or any linked
working tree to clean up any stale administrative files."

  ah, so one learns that the subcommand "prune" does *not* do any
actual pruning as people would *normally* understand it, it simply
deletes the administrative information about an already-deleted
worktree, do i read that correctly?

  that's emphasized further down in the actual definition of "prune":

    prune
        Prune working tree information in $GIT_DIR/worktrees.

but perhaps that explanation could be extended to say it only works on
already-deleted trees, since that's certainly not clear from that
single sentence.

  finally, the prune "--expire" option is truly confusing:

    --expire <time>
        With prune, only expire unused working trees older than <time>.

suddenly, we encounter the verb "expire", which means ... what? how
does "expiring" a worktree differ from "pruning" a worktree? and what
makes a worktree "unused"? the normal meaning of "unused" is that you
haven't, you know, *used* it lately. in this context, though, does it
mean deleted? and if it means deleted, what does it mean for it to be
older than some time if it's already gone?

  thoughts?

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

             reply	other threads:[~2017-11-13 14:49 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-13 14:48 Robert P. J. Day [this message]
2017-11-13 17:39 ` man page for "git-worktree" is a bit confusing WRT "prune" Eric Sunshine
2017-11-13 21:06   ` Robert P. J. Day
2017-11-14  3:26     ` Eric Sunshine
2017-11-14  8:47       ` Robert P. J. Day

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

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

  git send-email \
    --in-reply-to=alpine.LFD.2.21.1711130938080.5262@DESKTOP-1GPMCEJ \
    --to=rpjday@crashcourse.ca \
    --cc=git@vger.kernel.org \
    /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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.