[edk2-devel] [PATCH v1 08/10] DynamicTablesPkg: Update DynamicTablesPkg.ci.yaml

[PierreGondois]

From: Pierre Gondois <Pierre.Gondois at 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 at 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/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-