Re: [PATCH v2 1/1] editorconfig: introduce .editorconfig
Hi Dzmitry, On Wed, Mar 1, 2023 at 7:44 AM 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 You missed giving your Signed-off-by tag.
Re: [PATCH v2 1/1] editorconfig: introduce .editorconfig
On Thu, Mar 02, 2023 at 06:00:43PM +0300, Dzmitry Sankouski wrote:
> ср, 1 мар. 2023 г. в 18:58, Tom Rini :
> >
> > 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
> > > ---
> > > 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 00..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".
> >
> oops, I thought he meant consistent spacing in a sense of 8 spaces.
> I personally like Kconfigs with 4 indent more.
Ah. But, in both cases it should be 8, as well.
--
Tom
signature.asc
Description: PGP signature
Re: [PATCH v2 1/1] editorconfig: introduce .editorconfig
ср, 1 мар. 2023 г. в 18:58, Tom Rini :
>
> 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
> > ---
> > 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 00..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".
>
oops, I thought he meant consistent spacing in a sense of 8 spaces.
I personally like Kconfigs with 4 indent more.
Re: [PATCH v2 1/1] editorconfig: introduce .editorconfig
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
> ---
> 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 00..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
signature.asc
Description: PGP signature
[PATCH v2 1/1] editorconfig: introduce .editorconfig
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
---
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 00..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
+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
+ 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
--
2.30.2
