Re: [Xen-devel] [RFC] xen: Add .astylerc for automated style-formatting

From: Julien Grall <julien.grall@arm.com>
To: Tamas K Lengyel <tamas@tklengyel.com>
Cc: Artem Mygaiev <Artem_Mygaiev@epam.com>,
	Lars Kurth <lars.kurth@citrix.com>,
	Stefano Stabellini <sstabellini@kernel.org>, Wei Liu <wl@xen.org>,
	Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>,
	George Dunlap <George.Dunlap@eu.citrix.com>,
	Andrew Cooper <andrew.cooper3@citrix.com>,
	Ian Jackson <ian.jackson@eu.citrix.com>, Tim Deegan <tim@xen.org>,
	Iurii Artemenko <Iurii_Artemenko@epam.com>,
	Jan Beulich <jbeulich@suse.com>,
	Xen-devel <xen-devel@lists.xenproject.org>
Subject: Re: [Xen-devel] [RFC] xen: Add .astylerc for automated style-formatting
Date: Fri, 19 Jul 2019 14:11:42 +0100	[thread overview]
Message-ID: <a0c71023-2546-d7c4-771c-02a944c93d90@arm.com> (raw)
In-Reply-To: <CABfawhk4TzQemnG+3XwtQ4SGmquufOd4nFGajEWJJ++YFuqfZw@mail.gmail.com>

Hi Tamas,

On 19/07/2019 14:00, Tamas K Lengyel wrote:
> On Fri, Jul 19, 2019 at 2:43 AM Julien Grall <julien.grall@arm.com> wrote:
>>
>> Hi Tamas,
>>
>> On 18/07/2019 18:48, Tamas K Lengyel wrote:
>>>>      - Line 1025: The tools needs to be able to deal for_each_vcpu(...) & co.
>>>
>>> These can be made OK by adding braces. Other than that the only way I
>>> found to make it not change the indentation is to add the comment "/*
>>> *INDENT-OFF* */" before the block and "/* *INDENT-ON* */" afterwards.
>>
>> None of them looks really appealing because it means astyle will not correctly
>> indent if the user does not add braces or comments.
>>
>> Could astyle be easily modified to recognize foreach macros?
> 
> Not that I'm aware of. If you don't want to manually annotate files
> with unsupported macros then just exclude those files from astyle. I
> wouldn't recommend adding this to the CI for all files, only for those
> that their respective maintainers have confirmed to conform to the
> style and want to enforce it going forward.

So a couple use of an unsupported macros would make impossible to enforce the 
coding style. This is not a very ideal position to be in.

_if_ we are going to adopt astyle then we need to be able to enforce it on every 
Xen files long-term. If it is not possible to do it with astyle, then maybe this 
is not the right tool to use.

For instance, I know that tools such as clang-format is able to deal with 
foreach macros.

Cheers,

-- 
Julien Grall

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel