From: Junio C Hamano <gitster@pobox.com>
To: "D. Ben Knoble" <ben.knoble@gmail.com>
Cc: git@vger.kernel.org, Patrick Steinhardt <ps@pks.im>
Subject: Re: [PATCH v2] CodingGuidelines: document NEEDSWORK comments
Date: Thu, 12 Feb 2026 14:33:55 -0800 [thread overview]
Message-ID: <xmqq3435mw18.fsf@gitster.g> (raw)
In-Reply-To: <CALnO6CAjd0vbi0S+giYBwsyQwFmSZoWUBQMKiUEokCEeaNTnrQ@mail.gmail.com> (D. Ben Knoble's message of "Thu, 12 Feb 2026 17:22:05 -0500")
"D. Ben Knoble" <ben.knoble@gmail.com> writes:
> Small nit:
>
> On Thu, Feb 12, 2026 at 4:23 PM Junio C Hamano <gitster@pobox.com> wrote:
>>
>> We often say things like /* NEEDSWORK: further _do_ _this_ */ in
>> comments, but it is a short-hand to say "We might later want to do
>> this. We might not. We do not have to decide it right now at this
>> moment in the commit this comment was added. If somebody is
>> inclined to work in this area further, the first thing they need to
>> do is to figure out if it truly makes sense to do so, before blindly
>> doing it.
>>
>> This seems to have never been documented. Do so now.
>>
>> Signed-off-by: Junio C Hamano <gitster@pobox.com>
>
> The opening quote '"We might later…' doesn't appear to ever get closed.
Yikes. Thanks for spotting.
next prev parent reply other threads:[~2026-02-12 22:33 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-11 19:17 [PATCH] CodingGuidelines: document NEEDSWORK comments Junio C Hamano
2026-02-12 7:10 ` Patrick Steinhardt
2026-02-12 15:35 ` Junio C Hamano
2026-02-12 21:22 ` [PATCH v2] " Junio C Hamano
2026-02-12 22:22 ` D. Ben Knoble
2026-02-12 22:33 ` Junio C Hamano [this message]
2026-02-14 10:19 ` Oswald Buddenhagen
2026-02-14 15:36 ` Junio C Hamano
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=xmqq3435mw18.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=ben.knoble@gmail.com \
--cc=git@vger.kernel.org \
--cc=ps@pks.im \
/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.