From: Pierre Gondois <Pierre.Gondois@arm.com>

To prepare edk2 upstream CI for incoming modifications:
1- Disable the Ecc check 9005:
   "Only Doxygen commands '@bug', '@todo', [...], '@{', '@}'
   are allowed to mark the code Unknown doxygen command [...]"
2- Disable the Ecc check 8003 for the following keyword:
   "DISABLE_NEW_DEPRECATED_INTERFACES"
   Indeed, this error has been corrected on the latest version of
   BaseTools, but is still triggered when using the older python
   packages containing the BaseTools.
3- Add word exceptions for the cspell tool.

Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
---
 DynamicTablesPkg/DynamicTablesPkg.ci.yaml | 29 +++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/DynamicTablesPkg/DynamicTablesPkg.ci.yaml b/DynamicTablesPkg/DynamicTablesPkg.ci.yaml
index 211615bc80e2..bfa282926e48 100644
--- a/DynamicTablesPkg/DynamicTablesPkg.ci.yaml
+++ b/DynamicTablesPkg/DynamicTablesPkg.ci.yaml
@@ -5,6 +5,28 @@
 # SPDX-License-Identifier: BSD-2-Clause-Patent
 ##
 {
+    "EccCheck": {
+        ## Exception sample looks like below:
+        ## "ExceptionList": [
+        ##     "<ErrorID>", "<KeyWord>"
+        ## ]
+        "ExceptionList": [
+        # "The #ifndef at the start of an include file should use
+        # both prefix and postfix underscore characters, '_'"
+        # This error is not triggered for the latest BaseTools code.
+        # @TODO The error should be re-enabled when the python packages
+        # containing the BaseTools are updated to the latest version.
+        "8003", "DISABLE_NEW_DEPRECATED_INTERFACES",
+        "9005", "@defgroup",      # Use extra Doxygen commands
+        "9005", "@ingroup",       # Use extra Doxygen commands
+        "9005", "@mainpage",      # Use extra Doxygen commands
+        "9005", "@ref",           # Use extra Doxygen commands
+        ],
+        ## Both file path and directory path are accepted.
+        "IgnoreFiles": [
+        ]
+    },
+
     ## options defined .pytool/Plugin/CompilerPlugin
     "CompilerPlugin": {
         "DscPath": "DynamicTablesPkg.dsc"
@@ -23,6 +45,7 @@
     ## options defined .pytool/Plugin/DependencyCheck
     "DependencyCheck": {
         "AcceptableDependencies": [
+            "ArmPkg/ArmPkg.dec",
             "ArmPlatformPkg/ArmPlatformPkg.dec",
             "EmbeddedPkg/EmbeddedPkg.dec",
             "DynamicTablesPkg/DynamicTablesPkg.dec",
@@ -77,19 +100,25 @@
            "CCIDX",
            "CCSIDR",
            "countof",
+           "edynamic",
            "EOBJECT",
            "invoc",
+           "ITARGETSR",
            "GTBLOCK",
            "lgreater",
            "lless",
            "MPIDR",
            "PERIPHBASE",
+           "phandle",
            "pytool",
+           "Rdword",
            "Roadmap",
            "ROOTNODEBASE",
            "ssdtcmn",
            "ssdtserialporttemplate",
            "SMMUV",
+           "ssdtpcieosctemplate",
+           "SSDTPC",
            "standardised",
            "TABLEEX",
            "TNSID",
-- 
2.17.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#76937): https://edk2.groups.io/g/devel/message/76937
Mute This Topic: https://groups.io/mt/83735191/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Hi Pierre,

On Wed, Jun 23, 2021 at 04:05 AM, PierreGondois wrote:

> 
> 2- Disable the Ecc check 8003 for the following keyword:
> "DISABLE_NEW_DEPRECATED_INTERFACES"
> Indeed, this error has been corrected on the latest version of
> BaseTools, but is still triggered when using the older python
> packages containing the BaseTools.

Can you check if the 8003 error needs to be disabled with latest Basetools, please? If not can you drop this part from the patch.

Regards,

Sami Mujawar


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#80978): https://edk2.groups.io/g/devel/message/80978
Mute This Topic: https://groups.io/mt/83735191/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Hi Sami,
Unfortunately this is still necessary,

cf
https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=29900&view=logs&j=216bd3cb-36c2-5579-221e-bd2f77088687&t=156c6dac-d9ee-52ac-8143-8428ed0a9e36

ERROR - EFI coding style error
ERROR - *Error code: 8003
ERROR - *The #ifndef at the start of an include file should use both
prefix and postfix underscore characters, '_'
ERROR - *file: D:\a\1\s\DynamicTablesPkg\Include\Library\AmlLib\AmlLib.h
ERROR - *Line number: 623
ERROR - *The #ifndef name [DISABLE_NEW_DEPRECATED_INTERFACES] does not
follow the rules

Regards,

Pierre


On 9/22/21 4:48 PM, Sami Mujawar via Groups.Io wrote:
> Hi Pierre,
>
> On Wed, Jun 23, 2021 at 04:05 AM, PierreGondois wrote:
>
>     2- Disable the Ecc check 8003 for the following keyword:
>     "DISABLE_NEW_DEPRECATED_INTERFACES"
>     Indeed, this error has been corrected on the latest version of
>     BaseTools, but is still triggered when using the older python
>     packages containing the BaseTools.
>
> Can you check if the 8003 error needs to be disabled with latest
> Basetools, please? If not can you drop this part from the patch.
>
> Regards,
>
> Sami Mujawar 


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#81015): https://edk2.groups.io/g/devel/message/81015
Mute This Topic: https://groups.io/mt/83735191/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-