public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: "brian m. carlson" <sandals@crustytoothpaste•net>
To: Junio C Hamano <gitster@pobox•com>
Cc: git@vger•kernel.org
Subject: Re: [rfd] a new core.whitespace class "\No newline at end of file"
Date: Wed, 8 Oct 2025 19:29:01 +0000	[thread overview]
Message-ID: <aOa7fWV5RgbyApiq@fruit.crustytoothpaste.net> (raw)
In-Reply-To: <xmqqjz15fg3i.fsf@gitster.g>

[-- Attachment #1: Type: text/plain, Size: 1461 bytes --]

On 2025-10-08 at 17:39:13, Junio C Hamano wrote:
> It would be a good sized internship project to introduce a new
> core.whitespace class that is about a file that ends in an
> incomplete line (it would be way too big as a microproject, so I would
> not add the #leftoverbits tag to this one).
> 
> The student needs to learn quite a lot of things, including
> 
>  - they need to study the diff machinery to learn how existing
>    whitespace breakages are reported, in order to figure out how to
>    add a new class of whitespace breakage;
> 
>  - they need to find a good name for this new class;
> 
>  - they need to study the apply machinery to learn how existing
>    whitespace breakages are reported or corrected, in order to
>    figure out how to add support for this new class.
> 
> Thoughts?

I think this is a great idea.  I've noticed that many newer developers
are using VS Code, which I believe leaves off the trailing newline by
default.

I think most people on this list understand why having a newline at the
end of the file is valuable and have configured their editors
accordingly, but for less experienced developers, this kind of lint
could be useful to help visualize these problems and even catch them in
CI.  Possibly the documentation (say, the FAQ) could be updated to help
explain why this kind of whitespace breakage should be avoided as well.
-- 
brian m. carlson (they/them)
Toronto, Ontario, CA

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 262 bytes --]

      reply	other threads:[~2025-10-08 19:29 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-08 17:39 [rfd] a new core.whitespace class "\No newline at end of file" Junio C Hamano
2025-10-08 19:29 ` brian m. carlson [this message]

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=aOa7fWV5RgbyApiq@fruit.crustytoothpaste.net \
    --to=sandals@crustytoothpaste$(echo .)net \
    --cc=git@vger$(echo .)kernel.org \
    --cc=gitster@pobox$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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