[PATCH v2 1/1] Add a .editorconfig file to tell editors basic formatting details

[PATCH v2 1/1] Add a .editorconfig file to tell editors basic formatting details

[Rebecca Cran]

Add a .editorconfig file which editors can use for basic formatting
details of files, such as tabs/spaces, line endings etc.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
---
 .editorconfig | 31 ++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 000000000000..587d5bbaa884
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,31 @@
+# EditorConfig file: https://EditorConfig.org
+
+root = true
+
+[*]
+charset = latin1
+end_of_line = crlf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[*.sh]
+end_of_line = lf
+
+[.gitattributes]
+end_of_line = lf
+
+[.mailmap]
+charset = utf-8
+
+[Maintainers.txt]
+charset = utf-8
+
+[Makefile,GNUmakefile]
+indent_style = tab
-- 
2.37.1 (Apple Git-137.1)

Re: [PATCH v2 1/1] Add a .editorconfig file to tell editors basic formatting details

[Ard Biesheuvel]

On Wed, 1 Mar 2023 at 19:19, Rebecca Cran <rebecca@bsdio.com> wrote:
>
> Add a .editorconfig file which editors can use for basic formatting
> details of files, such as tabs/spaces, line endings etc.
>
> Signed-off-by: Rebecca Cran <rebecca@bsdio.com>

Reviewed-by: Ard Biesheuvel <ardb@kernel.org>

Thanks!

> ---
>  .editorconfig | 31 ++++++++++++++++++++
>  1 file changed, 31 insertions(+)
>
> diff --git a/.editorconfig b/.editorconfig
> new file mode 100644
> index 000000000000..587d5bbaa884
> --- /dev/null
> +++ b/.editorconfig
> @@ -0,0 +1,31 @@
> +# EditorConfig file: https://EditorConfig.org
> +
> +root = true
> +
> +[*]
> +charset = latin1
> +end_of_line = crlf
> +indent_style = space
> +indent_size = 2
> +insert_final_newline = true
> +trim_trailing_whitespace = true
> +
> +[*.py]
> +charset = utf-8
> +indent_style = space
> +indent_size = 4
> +
> +[*.sh]
> +end_of_line = lf
> +
> +[.gitattributes]
> +end_of_line = lf
> +
> +[.mailmap]
> +charset = utf-8
> +
> +[Maintainers.txt]
> +charset = utf-8
> +
> +[Makefile,GNUmakefile]
> +indent_style = tab
> --
> 2.37.1 (Apple Git-137.1)
>

Re: [edk2-devel] [PATCH v2 1/1] Add a .editorconfig file to tell editors basic formatting details

[Ard Biesheuvel]

On Wed, 1 Mar 2023 at 23:11, Ard Biesheuvel <ardb@kernel.org> wrote:
>
> On Wed, 1 Mar 2023 at 19:19, Rebecca Cran <rebecca@bsdio.com> wrote:
> >
> > Add a .editorconfig file which editors can use for basic formatting
> > details of files, such as tabs/spaces, line endings etc.
> >
> > Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
>
> Reviewed-by: Ard Biesheuvel <ardb@kernel.org>
>

Can we get this merged please? Thanks.


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108449): https://edk2.groups.io/g/devel/message/108449
Mute This Topic: https://groups.io/mt/97321658/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH v2 1/1] Add a .editorconfig file to tell editors basic formatting details

[Michael D Kinney]

Acked-by: Michael D Kinney <michael.d.kinney@intel.com>

> -----Original Message-----
> From: Ard Biesheuvel <ardb@kernel.org>
> Sent: Friday, September 8, 2023 8:14 AM
> To: Rebecca Cran <rebecca@bsdio.com>
> Cc: devel@edk2.groups.io; Andrew Fish <afish@apple.com>; Leif Lindholm
> <quic_llindhol@quicinc.com>; Kinney, Michael D
> <michael.d.kinney@intel.com>
> Subject: Re: [PATCH v2 1/1] Add a .editorconfig file to tell editors
> basic formatting details
> 
> On Wed, 1 Mar 2023 at 23:11, Ard Biesheuvel <ardb@kernel.org> wrote:
> >
> > On Wed, 1 Mar 2023 at 19:19, Rebecca Cran <rebecca@bsdio.com> wrote:
> > >
> > > Add a .editorconfig file which editors can use for basic formatting
> > > details of files, such as tabs/spaces, line endings etc.
> > >
> > > Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
> >
> > Reviewed-by: Ard Biesheuvel <ardb@kernel.org>
> >
> 
> Can we get this merged please? Thanks.


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108451): https://edk2.groups.io/g/devel/message/108451
Mute This Topic: https://groups.io/mt/97321658/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/12367111/7686176/1913456212/xyzzy [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH v2 1/1] Add a .editorconfig file to tell editors basic formatting details

[Ard Biesheuvel]

On Fri, 8 Sept 2023 at 17:54, Michael D Kinney
<michael.d.kinney@intel.com> wrote:
>
> Acked-by: Michael D Kinney <michael.d.kinney@intel.com>
>

Thanks

I can merge this but note that we'll need to convert it to CR-LF
first. (My VIM editor with editorconfig integration seems perfectly
happy with that)


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108453): https://edk2.groups.io/g/devel/message/108453
Mute This Topic: https://groups.io/mt/97321658/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH v2 1/1] Add a .editorconfig file to tell editors basic formatting details

[Rebecca Cran]

On 9/8/23 10:21, Ard Biesheuvel wrote:

> On Fri, 8 Sept 2023 at 17:54, Michael D Kinney
> <michael.d.kinney@intel.com> wrote:
>> Acked-by: Michael D Kinney <michael.d.kinney@intel.com>
>>
> Thanks
>
> I can merge this but note that we'll need to convert it to CR-LF
> first. (My VIM editor with editorconfig integration seems perfectly
> happy with that)

Good point - I'll fix the line endings and merge it.

Thinking of line endings, I was wondering if we might want to make the following additions to BaseTools/Conf/gitattributes, along with setting "core.autocrlf=false" and "core.eol=crlf"?

* text=auto
*.png -text
*.pyd -text
*.sh                                 eol=lf
.gitmodules                          eol=lf
BaseTools/BinWrappers/PosixLike/*    eol=lf
BaseTools/BinPipWrappers/PosixLike/* eol=lf
BaseTools/BuildEnv                   eol=lf
BaseTools/Conf/diff.order            eol=lf

-- 
Rebecca Cran



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108454): https://edk2.groups.io/g/devel/message/108454
Mute This Topic: https://groups.io/mt/97321658/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH v2 1/1] Add a .editorconfig file to tell editors basic formatting details

[Michael D Kinney]

I already have PR opened.  https://github.com/tianocore/edk2/pull/4811

Can you verify the line endings are correct?

Mike


> -----Original Message-----
> From: Ard Biesheuvel <ardb@kernel.org>
> Sent: Friday, September 8, 2023 9:21 AM
> To: devel@edk2.groups.io; Kinney, Michael D <michael.d.kinney@intel.com>
> Cc: Rebecca Cran <rebecca@bsdio.com>; Andrew Fish <afish@apple.com>; Leif
> Lindholm <quic_llindhol@quicinc.com>
> Subject: Re: [edk2-devel] [PATCH v2 1/1] Add a .editorconfig file to tell
> editors basic formatting details
> 
> On Fri, 8 Sept 2023 at 17:54, Michael D Kinney
> <michael.d.kinney@intel.com> wrote:
> >
> > Acked-by: Michael D Kinney <michael.d.kinney@intel.com>
> >
> 
> Thanks
> 
> I can merge this but note that we'll need to convert it to CR-LF
> first. (My VIM editor with editorconfig integration seems perfectly
> happy with that)


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108455): https://edk2.groups.io/g/devel/message/108455
Mute This Topic: https://groups.io/mt/97321658/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/12367111/7686176/1913456212/xyzzy [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH v2 1/1] Add a .editorconfig file to tell editors basic formatting details

[Rebecca Cran]

Looks good.


$ file .editorconfig
.editorconfig: ASCII text, with CRLF line terminators


On 9/8/23 10:31, Kinney, Michael D wrote:
> I already have PR opened.  https://github.com/tianocore/edk2/pull/4811
>
> Can you verify the line endings are correct?
>
> Mike
>
>
>> -----Original Message-----
>> From: Ard Biesheuvel <ardb@kernel.org>
>> Sent: Friday, September 8, 2023 9:21 AM
>> To: devel@edk2.groups.io; Kinney, Michael D <michael.d.kinney@intel.com>
>> Cc: Rebecca Cran <rebecca@bsdio.com>; Andrew Fish <afish@apple.com>; Leif
>> Lindholm <quic_llindhol@quicinc.com>
>> Subject: Re: [edk2-devel] [PATCH v2 1/1] Add a .editorconfig file to tell
>> editors basic formatting details
>>
>> On Fri, 8 Sept 2023 at 17:54, Michael D Kinney
>> <michael.d.kinney@intel.com> wrote:
>>> Acked-by: Michael D Kinney <michael.d.kinney@intel.com>
>>>
>> Thanks
>>
>> I can merge this but note that we'll need to convert it to CR-LF
>> first. (My VIM editor with editorconfig integration seems perfectly
>> happy with that)


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108458): https://edk2.groups.io/g/devel/message/108458
Mute This Topic: https://groups.io/mt/97321658/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH v2 1/1] Add a .editorconfig file to tell editors basic formatting details

[Michael D Kinney]

Merged: https://github.com/tianocore/edk2/commit/d42ad81e2247bc6f1c30ef7be5fafc6fcfa0dfb9


> -----Original Message-----
> From: Rebecca Cran <rebecca@bsdio.com>
> Sent: Friday, September 8, 2023 10:08 AM
> To: Kinney, Michael D <michael.d.kinney@intel.com>; Ard Biesheuvel
> <ardb@kernel.org>; devel@edk2.groups.io
> Cc: Andrew Fish <afish@apple.com>; Leif Lindholm
> <quic_llindhol@quicinc.com>
> Subject: Re: [edk2-devel] [PATCH v2 1/1] Add a .editorconfig file to tell
> editors basic formatting details
> 
> Looks good.
> 
> 
> $ file .editorconfig
> .editorconfig: ASCII text, with CRLF line terminators
> 
> 
> On 9/8/23 10:31, Kinney, Michael D wrote:
> > I already have PR opened.  https://github.com/tianocore/edk2/pull/4811
> >
> > Can you verify the line endings are correct?
> >
> > Mike
> >
> >
> >> -----Original Message-----
> >> From: Ard Biesheuvel <ardb@kernel.org>
> >> Sent: Friday, September 8, 2023 9:21 AM
> >> To: devel@edk2.groups.io; Kinney, Michael D <michael.d.kinney@intel.com>
> >> Cc: Rebecca Cran <rebecca@bsdio.com>; Andrew Fish <afish@apple.com>;
> Leif
> >> Lindholm <quic_llindhol@quicinc.com>
> >> Subject: Re: [edk2-devel] [PATCH v2 1/1] Add a .editorconfig file to
> tell
> >> editors basic formatting details
> >>
> >> On Fri, 8 Sept 2023 at 17:54, Michael D Kinney
> >> <michael.d.kinney@intel.com> wrote:
> >>> Acked-by: Michael D Kinney <michael.d.kinney@intel.com>
> >>>
> >> Thanks
> >>
> >> I can merge this but note that we'll need to convert it to CR-LF
> >> first. (My VIM editor with editorconfig integration seems perfectly
> >> happy with that)


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108460): https://edk2.groups.io/g/devel/message/108460
Mute This Topic: https://groups.io/mt/97321658/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/12367111/7686176/1913456212/xyzzy [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-