Re: [PATCH v4 3/7] builtin/gc: move pruning of worktrees into a separate function

From: Patrick Steinhardt <ps@pks.im>
Date: May 7, 2025, 07:06 UTC
Message-ID: <aBsGiu3IBIUuYuYU@pks.im>
In-Reply-To: <CAP8UFD1ZtYMf0ja75AV_jGJgzAL919zpHoGy0v-G2tNV+OEDwA@mail.gmail.com>

On Tue, May 06, 2025 at 09:50:12AM +0200, Christian Couder wrote:

Show 6 quoted lines

> On Mon, May 5, 2025 at 10:52 AM Patrick Steinhardt <ps@pks.im> wrote:
> >
> > Move pruning of worktrees into a separate function.
> 
> Repeating the subject at the beginning of the body part of the commit
> message doesn't bring much value.

I disagree with that statement. The way I review commit messages the subject is often detached from the body, so it always helps me quite a bit when the body is fully self-contained and doesn't depend on the subject.

Show 13 quoted lines

> > This prepares for a
> > subsequent commit where we introduce a new "worktree-prune" task for
> > git-maintenance(1).
> 
> I think it might help a bit to reword in the usual "describe the
> problem first and then say what to do about it" way. Maybe something
> like:
> 
> "In a subsequent commit we are going to introduce a new
> "worktree-prune" task for git-maintenance(1).
> 
> To prepare for this, refactor the code that prunes worktrees into a
> separate function."

But this reads better regardless of that, so I'll take it. Thanks!

Patrick