git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2] CodingGuidelines: document NEEDSWORK comments

From
Junio C Hamano <gitster@pobox.com>
Date
Feb 12, 2026, 22:33 UTC
Message-ID
<xmqq3435mw18.fsf@gitster.g>
In-Reply-To
<CALnO6CAjd0vbi0S+giYBwsyQwFmSZoWUBQMKiUEokCEeaNTnrQ@mail.gmail.com>
"D. Ben Knoble" <ben.knoble@gmail.com> writes:
Show 17 quoted lines
> 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.
Previous: D. Ben KnobleNext: Oswald Buddenhagen
Message 6 of 8 in “CodingGuidelines: document NEEDSWORK comments”
  1. CodingGuidelines: document NEEDSWORK commentsJunio C Hamano, Feb 11, 2026
  2. Patrick SteinhardtFeb 12, 2026
  3. Junio C HamanoFeb 12, 2026
  4. CodingGuidelines: document NEEDSWORK commentsJunio C Hamano, Feb 12, 2026
  5. D. Ben KnobleFeb 12, 2026
  6. Junio C HamanoFeb 12, 2026
  7. Oswald BuddenhagenFeb 14, 2026
  8. Junio C HamanoFeb 14, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.