Re: [PATCH v2] branch: rework the descriptions of rename and copy operations

From: Junio C Hamano <gitster@pobox.com>
Date: Feb 16, 2024, 21:45 UTC
Message-ID: <xmqqh6i8gk20.fsf@gitster.g>
In-Reply-To: <608b4e81d71a95c820f1e4068382d391@manjaro.org>

Dragan Simic <dsimic@manjaro.org> writes:

Show 9 quoted lines

>> But the halfway modification to the description section in this
>> patch is not an improvement.  It makes some options described there
>> while -m and -c are completely missing now, making the section
>> incomplete and coverage of the operating modes of the command
>> uneven.
>
> If I got it right, you'd prefer this patch not to be accepted
> separately, but as part of the future series that would rework the
> entire git-branch(1) man page?  I'm fine with that as well.

Not necessarily. If you wanted to this this in multiple steps, we can first whip the OPTIONS part into a good shape, and then fix the DESCRIPTION part.

What we want to avoid (not limited to this topic) is to say "this temporarily makes things worse here, but trust me it will eventually become perfect". Removing only -m/-c from the description section makes the description section worse than before the patch---we'd be better off leaving the original as-is if we are not revamping the entire section.