Date:   Fri, 2 Jun 2023 17:37:31 +0200
From:   Mickaël Salaün <mic@...ikod.net>
To:     Íñigo Huguet <ihuguet@...hat.com>,
        ojeda@...nel.org, danny@...ag0n.dev
Cc:     masahiroy@...nel.org, jgg@...dia.com, linux-kernel@...r.kernel.org,
        corbet@....net, joe@...ches.com, linux@...musvillemoes.dk,
        willy@...radead.org, mailhol.vincent@...adoo.fr
Subject: Re: [PATCH v4] Add .editorconfig file for basic formatting

Looks good to me, thanks!

Acked-by: Mickaël Salaün <mic@...ikod.net>

It would be nice to have a script to check files and output a diff if 
they are not in line with this configuration. That could also be used to 
measure how many files are compliant with these rules, and add this 
stats in the commit message.

For some reasons, maintainers may want to exclude some files from these 
constraints. It would be useful to add some documentation explaining how 
to do it.


On 01/06/2023 09:53, Íñigo Huguet wrote:
> EditorConfig is a specification to define the most basic code formatting
> stuff, and it's supported by many editors and IDEs, either directly or
> via plugins, including VSCode/VSCodium, Vim, emacs and more.
> 
> It allows to define formatting style related to indentation, charset,
> end of lines and trailing whitespaces. It also allows to apply different
> formats for different files based on wildcards, so for example it is
> possible to apply different configs to *.{c,h}, *.py and *.rs.
> 
> In linux project, defining a .editorconfig might help to those people
> that work on different projects with different indentation styles, so
> they cannot define a global style. Now they will directly see the
> correct indentation on every fresh clone of the project.
> 
> See https://editorconfig.org
> 
> Co-developed-by: Danny Lin <danny@...ag0n.dev>
> Signed-off-by: Danny Lin <danny@...ag0n.dev>
> Signed-off-by: Íñigo Huguet <ihuguet@...hat.com>
> ---
> v2:
> - added special rule for patch files so it doesn't remove
>    trailing whitespaces, making them unusable.
> v3:
> - moved all rules from [*] section to all the individual
>    sections so they doesn't affect to unexpected files.
> - added some extensions and files from a patch from Danny
>    Lin that didn't get to be merged:
>    https://lore.kernel.org/lkml/20200703073143.423557-1-danny@kdrag0n.dev/
>    However, the following file types hasn't been added
>    because they don't have a clear common style:
>    rst,pl,cocci,tc,bconf,svg,xsl,manual pages
> v4:
> - Analyzed with a script the styles used by different file types
> - Added rules for awd, dts, dtsi, dtso, s, S
> - Removed rules for rb and pm that has very few files in the tree
> - Removed rules for tools/perf/scripts/*/bin/*
> - Changed rules for py to better match the 2 styles that are present in
>    the tree: 4 spaces by default and tabs for files in subdirectories
>    tools/{perf,power,rcu,testing/kunit}
> ---
>   .editorconfig                          | 32 ++++++++++++++++++++++++++
>   .gitignore                             |  1 +
>   Documentation/process/4.Coding.rst     |  4 ++++
>   Documentation/process/coding-style.rst |  4 ++++
>   4 files changed, 41 insertions(+)
>   create mode 100644 .editorconfig
> 
> diff --git a/.editorconfig b/.editorconfig
> new file mode 100644
> index 000000000000..854773350cc5
> --- /dev/null
> +++ b/.editorconfig
> @@ -0,0 +1,32 @@
> +# SPDX-License-Identifier: GPL-2.0-only
> +
> +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
> +
> +[*.{json,py,rs}]
> +charset = utf-8
> +end_of_line = lf
> +trim_trailing_whitespace = true
> +insert_final_newline = true
> +indent_style = space
> +indent_size = 4
> +
> +# this must be below the general *.py to overwrite it
> +[tools/{perf,power,rcu,testing/kunit}/**.py,]
> +indent_style = tab
> +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
> diff --git a/.gitignore b/.gitignore
> index 70ec6037fa7a..e4b3fe1d029b 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -100,6 +100,7 @@ modules.order
>   #
>   !.clang-format
>   !.cocciconfig
> +!.editorconfig
>   !.get_maintainer.ignore
>   !.gitattributes
>   !.gitignore
> diff --git a/Documentation/process/4.Coding.rst b/Documentation/process/4.Coding.rst
> index 1f0d81f44e14..c2046dec0c2f 100644
> --- a/Documentation/process/4.Coding.rst
> +++ b/Documentation/process/4.Coding.rst
> @@ -66,6 +66,10 @@ for aligning variables/macros, for reflowing text and other similar tasks.
>   See the file :ref:`Documentation/process/clang-format.rst <clangformat>`
>   for more details.
>   
> +Some basic editor settings, such as indentation and line endings, will be
> +set automatically if you are using an editor that is compatible with
> +EditorConfig. See the official EditorConfig website for more information:
> +https://editorconfig.org/
>   
>   Abstraction layers
>   ******************
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index 007e49ef6cec..ec96462fa8be 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -735,6 +735,10 @@ for aligning variables/macros, for reflowing text and other similar tasks.
>   See the file :ref:`Documentation/process/clang-format.rst <clangformat>`
>   for more details.
>   
> +Some basic editor settings, such as indentation and line endings, will be
> +set automatically if you are using an editor that is compatible with
> +EditorConfig. See the official EditorConfig website for more information:
> +https://editorconfig.org/
>   
>   10) Kconfig configuration files
>   -------------------------------

Powered by blists - more mailing lists