[PATCH v2] .editorconfig: remove trim_trailing_whitespace option

Greg Kroah-Hartman posted 1 patch 1 year, 8 months ago
.editorconfig | 3 ---
1 file changed, 3 deletions(-)
[PATCH v2] .editorconfig: remove trim_trailing_whitespace option
Posted by Greg Kroah-Hartman 1 year, 8 months ago
Some editors (like the vim variants), when seeing "trim_whitespace"
decide to do just that for all of the whitespace in the file you are
saving, even if it is not on a line that you have modified.  This plays
havoc with diffs and is NOT something that should be intended.

As the "only trim whitespace on modified files" is not part of the
editorconfig standard yet, just delete these lines from the
.editorconfig file so that we don't end up with diffs that are
automatically rejected by maintainers for containing things they
shouldn't.

Cc: Danny Lin <danny@kdrag0n.dev>
Cc: Íñigo Huguet <ihuguet@redhat.com>
Cc: Mickaël Salaün <mic@digikod.net>
Cc: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Cc: Masahiro Yamada <masahiroy@kernel.org>
Fixes: 5a602de99797 ("Add .editorconfig file for basic formatting")
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
v2: - only remove the lines, don't move the whole file to Documentation
    - add Fixes: tag


 .editorconfig | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/.editorconfig b/.editorconfig
index 854773350cc5..29a30ccfc07b 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -5,7 +5,6 @@ root = true
 [{*.{awk,c,dts,dtsi,dtso,h,mk,s,S},Kconfig,Makefile,Makefile.*}]
 charset = utf-8
 end_of_line = lf
-trim_trailing_whitespace = true
 insert_final_newline = true
 indent_style = tab
 indent_size = 8
@@ -13,7 +12,6 @@ indent_size = 8
 [*.{json,py,rs}]
 charset = utf-8
 end_of_line = lf
-trim_trailing_whitespace = true
 insert_final_newline = true
 indent_style = space
 indent_size = 4
@@ -26,7 +24,6 @@ indent_size = 8
 [*.yaml]
 charset = utf-8
 end_of_line = lf
-trim_trailing_whitespace = unset
 insert_final_newline = true
 indent_style = space
 indent_size = 2
-- 
2.45.2

Re: [PATCH v2] .editorconfig: remove trim_trailing_whitespace option
Posted by Jani Nikula 1 year, 8 months ago
On Tue, 11 Jun 2024, Greg Kroah-Hartman <gregkh@linuxfoundation.org> wrote:
> Some editors (like the vim variants), when seeing "trim_whitespace"
> decide to do just that for all of the whitespace in the file you are
> saving, even if it is not on a line that you have modified.  This plays
> havoc with diffs and is NOT something that should be intended.
>
> As the "only trim whitespace on modified files" is not part of the

Do you mean s/files/lines/?

BR,
Jani.

> editorconfig standard yet, just delete these lines from the
> .editorconfig file so that we don't end up with diffs that are
> automatically rejected by maintainers for containing things they
> shouldn't.

-- 
Jani Nikula, Intel
Re: [PATCH v2] .editorconfig: remove trim_trailing_whitespace option
Posted by Greg Kroah-Hartman 1 year, 8 months ago
On Thu, Jun 13, 2024 at 09:16:14AM +0300, Jani Nikula wrote:
> On Tue, 11 Jun 2024, Greg Kroah-Hartman <gregkh@linuxfoundation.org> wrote:
> > Some editors (like the vim variants), when seeing "trim_whitespace"
> > decide to do just that for all of the whitespace in the file you are
> > saving, even if it is not on a line that you have modified.  This plays
> > havoc with diffs and is NOT something that should be intended.
> >
> > As the "only trim whitespace on modified files" is not part of the
> 
> Do you mean s/files/lines/?

Yes.  I'll edit this when I commit it as it's driving me crazy already
and I think it needs to get to Linus "soon" before we start to see lots
of busted patches sent to maintainers...

thanks,

greg k-h
Re: [PATCH v2] .editorconfig: remove trim_trailing_whitespace option
Posted by Vincent MAILHOL 1 year, 8 months ago
On Tue. 11 juin 2024 at 16:27, Greg Kroah-Hartman
<gregkh@linuxfoundation.org> wrote:
> Some editors (like the vim variants), when seeing "trim_whitespace"
> decide to do just that for all of the whitespace in the file you are
> saving, even if it is not on a line that you have modified.  This plays
> havoc with diffs and is NOT something that should be intended.
>
> As the "only trim whitespace on modified files" is not part of the
> editorconfig standard yet, just delete these lines from the
> .editorconfig file so that we don't end up with diffs that are
> automatically rejected by maintainers for containing things they
> shouldn't.
>
> Cc: Danny Lin <danny@kdrag0n.dev>
> Cc: Íñigo Huguet <ihuguet@redhat.com>
> Cc: Mickaël Salaün <mic@digikod.net>
> Cc: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
> Cc: Masahiro Yamada <masahiroy@kernel.org>
> Fixes: 5a602de99797 ("Add .editorconfig file for basic formatting")
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

Thanks, this v2 is way better!

Acked-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>

> ---
> v2: - only remove the lines, don't move the whole file to Documentation
>     - add Fixes: tag
>
>
>  .editorconfig | 3 ---
>  1 file changed, 3 deletions(-)
>
> diff --git a/.editorconfig b/.editorconfig
> index 854773350cc5..29a30ccfc07b 100644
> --- a/.editorconfig
> +++ b/.editorconfig
> @@ -5,7 +5,6 @@ root = true
>  [{*.{awk,c,dts,dtsi,dtso,h,mk,s,S},Kconfig,Makefile,Makefile.*}]
>  charset = utf-8
>  end_of_line = lf
> -trim_trailing_whitespace = true
>  insert_final_newline = true
>  indent_style = tab
>  indent_size = 8
> @@ -13,7 +12,6 @@ indent_size = 8
>  [*.{json,py,rs}]
>  charset = utf-8
>  end_of_line = lf
> -trim_trailing_whitespace = true
>  insert_final_newline = true
>  indent_style = space
>  indent_size = 4
> @@ -26,7 +24,6 @@ indent_size = 8
>  [*.yaml]
>  charset = utf-8
>  end_of_line = lf
> -trim_trailing_whitespace = unset
>  insert_final_newline = true
>  indent_style = space
>  indent_size = 2
> --
> 2.45.2
>