Re: [PATCH] MdePkg/IndustryStandard: add definitions for ACPI 6.0 IORT

[Ard Biesheuvel <ard.biesheuvel@linaro.org>]

On 18 April 2017 at 12:01, Alexei Fedorov <Alexei.Fedorov@arm.com> wrote:
> So, should we follow the Coding Standards Specification or can just ditch it?
>

We all know that Tianocore/EDK2 has a steep learning curve, especially
when it comes to developers coming from the Linux/open source side.

This page

https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Specifications

lists 11 (!) different specs one must adhere to when contributing code
to EDK2. Some of them are mandatory or your code will not build, or
will build but will not run.

In my opinion, adhering to the specs is already difficult enough
without having to follow arbitrary rules which are so blatantly
violated in core areas of the tree (MdePkg and MdeModulePkg). So my
advice is simply to ignore the coding standard altogether, and in my
reviews, I am usually very lax about violations.

-- 
Ard.





>
> -----Original Message-----
> From: Ard Biesheuvel [mailto:ard.biesheuvel@linaro.org]
> Sent: 18 April 2017 11:13
> To: Alexei Fedorov <Alexei.Fedorov@arm.com>; Kinney, Michael D <michael.d.kinney@intel.com>; liming.gao@intel.com; leif.lindholm@linaro.org
> Cc: edk2-devel@lists.01.org; Lorenzo Pieralisi <Lorenzo.Pieralisi@arm.com>; Evan Lloyd <Evan.Lloyd@arm.com>
> Subject: Re: [edk2] [PATCH] MdePkg/IndustryStandard: add definitions for ACPI 6.0 IORT
>
> On 18 April 2017 at 11:07, Alexei Fedorov <Alexei.Fedorov@arm.com> wrote:
>>
>> Aren't comments like
>>
>> //
>> // Table header
>> //
>>
>> ,
>>
>> //
>> // Definition for ID mapping table shared by all node types //
>>
>> etc.  not allowed according to EDK II C Coding Standards Specification?
>>
>> 6.2.3 Avoid comments where the opening comment characters are alone on
>> a line.
>>
>> //
>>
>> // VIOLATION: Horror Vacui
>>
>> //
>>
>
> You must be joking
>
> $ git grep -E '/\*\*\s$' MdePkg/ MdeModulePkg/ |wc -l
> 16193
>
> IOW, there are more than 16000 occurrences of opening comment characters alone on a line in MdePkg+MdeModulePkg only
> IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.