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

Tom Rini trini at konsulko.com
Wed Mar 1 16:58:24 CET 2023


On Wed, Mar 01, 2023 at 01:43:38PM +0300, 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>
> ---
> Changes for 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..10fe165f09
> --- /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

As Simon noted before, this should be " = 8".

> +end_of_line = lf
> +trim_trailing_whitespace = true
> +insert_final_newline = true
> diff --git a/.gitignore b/.gitignore
> index 3a4d056edf..ed8ca226fe 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -7,6 +7,7 @@
>  #
>  .*
>  !.checkpatch.conf
> +!.editorconfig
>  *.a
>  *.asn1.[ch]
>  *.bin
> diff --git a/doc/develop/codingstyle.rst b/doc/develop/codingstyle.rst
> index 1d5d0192b3..741bc58b83 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

"using the"

> +  EditorConfig tool. Feel free to setup your editor to work with u-boot's

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20230301/d4c3172a/attachment.sig>


More information about the U-Boot mailing list