[PATCH v3 1/1] editorconfig: introduce .editorconfig

[Heinrich Schuchardt]

On 3/3/23 16:33, Dzmitry Sankouski wrote:
> Current process of sending patches includes running checkpatch.pl
> script for each patch, and fixing found style problems.
> EditorConfig may help to prevent some style related problems
> (like spaces vs tab indentation) on the fly.
>
> Reviewed-by: Simon Glass <sjg at chromium.org>
> Signed-off-by: Dzmitry Sankouski <dsankouski at gmail.com>
>
> ---
>
> Changes in v3:
> - add 'the' article in docs
> - fix spacing
> - add sign off tag
>
> Changes in v2:
> - add section in coding style rst doc
> - unify Kconfig with other files
>
>   .editorconfig               | 15 +++++++++++++++
>   .gitignore                  |  1 +
>   doc/develop/codingstyle.rst |  4 ++++
>   3 files changed, 20 insertions(+)
>   create mode 100644 .editorconfig
>
> diff --git a/.editorconfig b/.editorconfig
> new file mode 100644
> index 0000000000..df69cee160
> --- /dev/null
> +++ b/.editorconfig
> @@ -0,0 +1,15 @@
> +; This file is for unifying the coding style for different editors and IDEs.
> +; Plugins are available for notepad++, emacs, vim, gedit,
> +; textmate, visual studio, and more.
> +;
> +; See http://editorconfig.org for details.
> +
> +# Top-most EditorConfig file.
> +root = true
> +
> +[{**.c, **.h, **Kconfig}]
> +indent_style = tab
> +indent_size = 8
> +end_of_line = lf
> +trim_trailing_whitespace = true
> +insert_final_newline = true

For Python we follow PEP8 and use 4 spaces per indent. We use the same
for *.rst. Could you, please, add such a rule (possibly in a follow up
patch).

> diff --git a/.gitignore b/.gitignore
> index 3a4d056edf..ed8ca226fe 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -7,6 +7,7 @@
>   #
>   .*
>   !.checkpatch.conf
> +!.editorconfig

Why would you want to ignore the file?

Best regards

Heinrich

>   *.a
>   *.asn1.[ch]
>   *.bin
> diff --git a/doc/develop/codingstyle.rst b/doc/develop/codingstyle.rst
> index 1d5d0192b3..0bbac75d4e 100644
> --- a/doc/develop/codingstyle.rst
> +++ b/doc/develop/codingstyle.rst
> @@ -27,6 +27,10 @@ The following rules apply:
>     more information, read :doc:`checkpatch`. Note that this should be done
>     *before* posting on the mailing list!
>
> +* Some code style rules may be applied automatically by your editor using
> +  the EditorConfig tool. Feel free to setup your editor to work with u-boot's
> +  .editorconfig.
> +
>   * Source files originating from different projects (for example the MTD
>     subsystem or the hush shell code from the BusyBox project) may, after
>     careful consideration, be exempted from these rules. For such files, the