Re: [XEN PATCH v6] CODING_STYLE: Add a section on header guards naming conventions

[Jan Beulich <jbeulich@xxxxxxxx>]

On 30.09.2024 11:12, Frediano Ziglio wrote:
> On Mon, Sep 30, 2024 at 9:58 AM Jan Beulich <jbeulich@xxxxxxxx> wrote:
>>
>> On 12.09.2024 03:13, Stefano Stabellini wrote:
>>> Hi Jan, we have gone back and forth on this a few times, but neither
>>> Alessandro nor I fully understand your perspective. To help streamline
>>> the process and save time for everyone, I suggest you provide an example
>>> of the rules written in the style you believe is appropriate. Once you
>>> set the initial direction, Alessandro and I can continue and complete
>>> the rest in that preferred style.
>>
>> Header inclusion guards
>> -----------------------
>>
>> Unless otherwise specified, all header files should include proper
>> guards to prevent multiple inclusions. The following naming conventions
>> apply:
>>
>> - Guard names are derived from directory path underneath xen/ and the
>>   actual file name.  Path components are separated by double underscores.
>>   Alphabetic characters are converted to upper case.  Non-alphanumeric
>>   characters are replaced by single underscores.
> 
> Possibly there should be no cases; but about "Non-alphanumeric
> characters are replaced by single underscores" are we talking about
> sequences or single entities? I would say sequences so
> "Non-alphanumeric character sequences are replaced by single
> underscores".
> For instance "foo--bar.h" -> "FOO_BAR_H" and not "foo--bar.h" -> "FOO__BAR_H".

I think such files shouldn't be created in the first place. No matter
whether you replace by a single underscore or a sequence thereof,
ambiguities will arise.

> Another maybe not supported case is no ASCII characters in name. As
> far as I can see they are not supported. Is it written somewhere?

Yet more absurd names, imo, which even more so shouldn't be allowed in.

Jan