git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Rafael Silva <rafaeloliveira.cs@gmail.com>
Cc: git@vger.kernel.org, Eric Sunshine <sunshine@sunshineco.com>
Subject: Re: [RFC PATCH 0/2] teach `worktree list` to mark locked worktrees
Date: Mon, 28 Sep 2020 14:19:53 -0700	[thread overview]
Message-ID: <xmqqft71lhty.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <20200928154953.30396-1-rafaeloliveira.cs@gmail.com> (Rafael Silva's message of "Mon, 28 Sep 2020 15:49:51 +0000")

Rafael Silva <rafaeloliveira.cs@gmail.com> writes:

> This patch series introduces a new information on the git `worktree list`
> command output, to mark when a worktree is locked with a (locked) text mark.
>
> The intent is to improve the user experience to earlier sinalize that a linked
> worktree is locked, instead of realising later when attempting to remove it
> with `remove` command as it happened to me twice :)

Change with a good intention, it seems.

> The patches are divided into two parts. First part introduces
> the new marker to the worktree list command and small documentation
> change. And the second adds one test case into t2402 to test
> if the (locked) text will be properly set for a locked worktree, and
> not mistankely set to a unlocked or master worktree.

Probably they belong together in a single patch (I am saying this
after only seeing the above five lines, without reading either of
these two patches, so there may be some things in them that makes it
make sense to have them separate).

> This is the output of the worktree list with locked marker:
>
>   $ git worktree list
>   /repo/to/main                abc123 [master]
>   /path/to/unlocked-worktree1  456def [brancha]
>   /path/to/locked-worktree     123abc (detached HEAD) (locked)

Looks OK to me

> This patches are marked with RFC mainly due to:
>
>   - This will change the default behaviour of the worktree list, I am
>     not sure whether will be better to make this tuned via a config
>     and/or a git parameter. (assuming this change is a good idea ;) )

The default output is meant for human consumption (scripts that want
to read from the command and expect stable output would be using the
"--porcelain" option).

The ideal case is a new output is universally useful for everybody,
in which case we can just change it without any new configuration or
command line option.

>   - Perhaps the `(locked)` marker is not the best suitable way to output
>     this information and we might need to come with a better way.

It looks good enough to me.  I am not qualified to have a strong
opinion on this part, as I do not use the command all that often.

    $ git shortlog --no-merges --since=18.months builtin/worktree.c

tells me that Eric Sunshine (CC'ed) may be a good source of wisdom
on this command.

>   - I am a new contributor to the code base, still learning a lot of git
>     internals data structure and commands. Likely this patch will require
>     updates.

Welcome.

> Rafael Silva (2):
>   teach `list` to mark locked worktree
>   t2402: add test to locked linked worktree marker
>
>  Documentation/git-worktree.txt |  5 +++--
>  builtin/worktree.c             |  6 +++++-
>  t/t2402-worktree-list.sh       | 13 +++++++++++++
>  3 files changed, 21 insertions(+), 3 deletions(-)

  parent reply	other threads:[~2020-09-28 21:20 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-28 15:49 [RFC PATCH 0/2] teach `worktree list` to mark locked worktrees Rafael Silva
2020-09-28 15:49 ` [RFC PATCH 1/2] worktree: teach `list` to mark locked worktree Rafael Silva
2020-09-28 21:37   ` Junio C Hamano
2020-09-29 21:36     ` Rafael Silva
2020-09-30  7:35     ` Eric Sunshine
2020-09-28 15:49 ` [RFC PATCH 2/2] t2402: add test to locked linked worktree marker Rafael Silva
2020-09-28 21:54   ` Junio C Hamano
2020-09-29 21:37     ` Rafael Silva
2020-09-30  8:06   ` Eric Sunshine
2020-09-28 21:19 ` Junio C Hamano [this message]
2020-09-29 21:35   ` [RFC PATCH 0/2] teach `worktree list` to mark locked worktrees Rafael Silva
2020-09-30  7:19 ` Eric Sunshine
2020-10-02 16:28   ` Rafael Silva
2020-10-09 22:50     ` Eric Sunshine
2020-10-10 19:06       ` Rafael Silva
2020-10-10 18:55 ` [PATCH v2 0/1] Teach "worktree list" to annotate " Rafael Silva
2020-10-10 18:55   ` [PATCH v2 1/1] worktree: teach `list` to annotate locked worktree Rafael Silva
2020-10-11  6:26     ` Eric Sunshine
2020-10-11  6:34       ` Eric Sunshine
2020-10-11 10:04       ` Rafael Silva
2020-10-11 10:11   ` [PATCH v3 0/1] Teach "worktree list" to annotate locked worktrees Rafael Silva
2020-10-11 10:11     ` [PATCH v3] worktree: teach `list` to annotate locked worktree Rafael Silva
2020-10-12  2:24       ` Eric Sunshine

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=xmqqft71lhty.fsf@gitster.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=rafaeloliveira.cs@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.
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 NNTP newsgroup(s).