public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Sami Mujawar" <sami.mujawar@arm.com>
To: <devel@edk2.groups.io>
Cc: Sami Mujawar <sami.mujawar@arm.com>, <Alexei.Fedorov@arm.com>,
	<sean.brogan@microsoft.com>, <liming.gao@intel.com>,
	<michael.d.kinney@intel.com>, <Bret.Barkelew@microsoft.com>,
	<ard.biesheuvel@arm.com>, <Matteo.Carlini@arm.com>,
	<Laura.Moretta@arm.com>, <nd@arm.com>
Subject: [PATCH v3 2/2] DynamicTablesPkg: Add EDK2 Core CI support
Date: Fri, 7 Aug 2020 17:12:05 +0100	[thread overview]
Message-ID: <20200807161205.50468-3-sami.mujawar@arm.com> (raw)
In-Reply-To: <20200807161205.50468-1-sami.mujawar@arm.com>

The TianoCore EDKII project has introduced a Core CI infrastructure
using TianoCore EDKII Tools PIP modules:
  * https://pypi.org/project/edk2-pytool-library/
  * https://pypi.org/project/edk2-pytool-extensions/

The edk2\.pytool\Readme.md provides information to configure the
environment and to run local builds.

This patch defines the necessary settings for enabling the Core CI
builds for DynamicTablesPkg.
 - Add DynamicTablesPkg.ci.yaml for Core CI
 - Update ReadMe.md for details and instructions

Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
Reviewed-by: Alexei Fedorov <Alexei.Fedorov@arm.com>
---

Notes:
    v3:
     - No code change. Splitting v2 patch series into two series.     [Sami]
       The v3 series contains the patches for DynamicTablesPkg.
       Ref: https://edk2.groups.io/g/devel/message/63256
    
    v2:
      - Removed INF files from the DscCompleteCheck ignore list       [Sami]
        as these are now included in the component section of
        the dsc file.
      - Why are there modules not built during ci (The files          [Sean]
        listed in the DscCompleteCheck[IgnoreInf] list)
    
    v1:
      - Add EDK2 core CI support fro DynamicTablesPkg                 [Sami]

 DynamicTablesPkg/DynamicTablesPkg.ci.yaml | 92 ++++++++++++++++++++
 DynamicTablesPkg/Readme.md                | 71 +++++++++++++++
 2 files changed, 163 insertions(+)

diff --git a/DynamicTablesPkg/DynamicTablesPkg.ci.yaml b/DynamicTablesPkg/DynamicTablesPkg.ci.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..f39b8019461ea151f9b1cf4bc751604d6e044af2
--- /dev/null
+++ b/DynamicTablesPkg/DynamicTablesPkg.ci.yaml
@@ -0,0 +1,92 @@
+## @file
+# CI configuration for DynamicTablesPkg
+#
+# Copyright (c) 2020, ARM Limited. All rights reserved.<BR>
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+{
+    ## options defined .pytool/Plugin/CompilerPlugin
+    "CompilerPlugin": {
+        "DscPath": "DynamicTablesPkg.dsc"
+    },
+
+    ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
+    "HostUnitTestCompilerPlugin": {
+        "DscPath": "" # Don't support this test
+    },
+
+    ## options defined .pytool/Plugin/CharEncodingCheck
+    "CharEncodingCheck": {
+        "IgnoreFiles": []
+    },
+
+    ## options defined .pytool/Plugin/DependencyCheck
+    "DependencyCheck": {
+        "AcceptableDependencies": [
+            "ArmPlatformPkg/ArmPlatformPkg.dec",
+            "EmbeddedPkg/EmbeddedPkg.dec",
+            "DynamicTablesPkg/DynamicTablesPkg.dec",
+            "MdeModulePkg/MdeModulePkg.dec",
+            "MdePkg/MdePkg.dec"
+        ],
+        # For host based unit tests
+        "AcceptableDependencies-HOST_APPLICATION":[
+            "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
+        ],
+        # For UEFI shell based apps
+        "AcceptableDependencies-UEFI_APPLICATION":[],
+        "IgnoreInf": []
+    },
+
+    ## options defined .pytool/Plugin/DscCompleteCheck
+    "DscCompleteCheck": {
+        "IgnoreInf": [],
+        "DscPath": "DynamicTablesPkg.dsc"
+    },
+
+    ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck
+    "HostUnitTestDscCompleteCheck": {
+        "IgnoreInf": [""],
+        "DscPath": "" # Don't support this test
+    },
+
+    ## options defined .pytool/Plugin/GuidCheck
+    "GuidCheck": {
+        "IgnoreGuidName": [],
+        "IgnoreGuidValue": [],
+        "IgnoreFoldersAndFiles": [],
+        "IgnoreDuplicates": [],
+    },
+
+    ## options defined .pytool/Plugin/LibraryClassCheck
+    "LibraryClassCheck": {
+        "IgnoreHeaderFile": []
+    },
+
+    ## options defined .pytool/Plugin/SpellCheck
+    "SpellCheck": {
+        "AuditOnly": False,
+        "IgnoreFiles": [],           # use gitignore syntax to ignore errors
+                                     # in matching files
+        "ExtendWords": [
+           "CCIDX",
+           "CCSIDR",
+           "countof",
+           "EOBJECT",
+           "GTBLOCK",
+           "MPIDR",
+           "pytool",
+           "Roadmap",
+           "SMMUV",
+           "standardised",
+           "TABLEEX",
+           "TNSID",
+           "Vatos",
+           "WBINVD"
+           ],           # words to extend to the dictionary for this package
+        "IgnoreStandardPaths": [],   # Standard Plugin defined paths that
+                                     # should be ignore
+        "AdditionalIncludePaths": [] # Additional paths to spell check
+                                     # (wildcards supported)
+    }
+}
diff --git a/DynamicTablesPkg/Readme.md b/DynamicTablesPkg/Readme.md
index bcaae6daa5fff24d9f62639149e9f82c2665c682..e17ed3ac6fd2fbcaced7d64393b316d4d6f75283 100644
--- a/DynamicTablesPkg/Readme.md
+++ b/DynamicTablesPkg/Readme.md
@@ -131,9 +131,80 @@ Ensure that the iASL compiler used for building *Dynamic Tables Framework* has t
 This feature was made available in the *ACPICA Compiler update
 [Version 20180508](https://www.acpica.org/node/156)*, dated 8 May 2018 (2018-05-08).
 
+
+Running CI builds locally
+-------------------------
+
+The TianoCore EDKII project has introduced Core CI infrastructure using TianoCore EDKII Tools PIP modules:
+
+   -  *[edk2-pytool-library](https://pypi.org/project/edk2-pytool-library)*
+
+   - *[edk2-pytool-extensions](https://pypi.org/project/edk2-pytool-extensions)*
+
+
+The instructions to setup the CI environment are in *'edk2\\.pytool\\Readme.md'*
+
+## Building DynamicTablesPkg with Pytools
+
+1. [Optional] Create a Python Virtual Environment - generally once per workspace
+
+    ```
+        python -m venv <name of virtual environment>
+
+        e.g. python -m venv edk2-ci
+    ```
+
+2. [Optional] Activate Virtual Environment - each time new shell/command window is opened
+
+    ```
+        <name of virtual environment>/Scripts/activate
+
+        e.g. On a windows host PC run:
+             edk2-ci\Scripts\activate.bat
+    ```
+3. Install Pytools - generally once per virtual env or whenever pip-requirements.txt changes
+
+    ```
+        pip install --upgrade -r pip-requirements.txt
+    ```
+
+4. Initialize & Update Submodules - only when submodules updated
+
+    ```
+        stuart_setup -c .pytool/CISettings.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>
+
+        e.g. stuart_setup -c .pytool/CISettings.py TOOL_CHAIN_TAG=GCC5
+    ```
+
+5. Initialize & Update Dependencies - only as needed when ext_deps change
+
+    ```
+        stuart_update -c .pytool/CISettings.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>
+
+        e.g. stuart_update -c .pytool/CISettings.py TOOL_CHAIN_TAG=GCC5
+    ```
+
+6. Compile the basetools if necessary - only when basetools C source files change
+
+    ```
+        python BaseTools/Edk2ToolsBuild.py -t <ToolChainTag>
+    ```
+
+7. Compile DynamicTablesPkg
+
+    ```
+        stuart_build-c .pytool/CISettings.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>
+
+        e.g. stuart_ci_build -c .pytool/CISettings.py TOOL_CHAIN_TAG=GCC5 -p DynamicTablesPkg -a AARCH64 --verbose
+    ```
+
+    - use `stuart_build -c .pytool/CISettings.py -h` option to see help on additional options.
+
+
 Documentation
 -------------
 
 Refer to the following presentation from *UEFI Plugfest Seattle 2018*:
 
 [Dynamic Tables Framework: A Step Towards Automatic Generation of Advanced Configuration and Power Interface (ACPI) & System Management BIOS (SMBIOS) Tables](http://www.uefi.org/sites/default/files/resources/Arm_Dynamic%20Tables%20Framework%20A%20Step%20Towards%20Automatic%20Generation%20of%20Advanced%20Configuration%20and%20Power%20Interface%20%28ACPI%29%20%26%20System%20Management%20BIOS%20%28SMBIOS%29%20Tables%20_0.pdf)
+
-- 
'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'


      parent reply	other threads:[~2020-08-07 16:12 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-07 16:12 [PATCH v3 0/2] Add EDKII CI support for DynamicTablesPkg Sami Mujawar
2020-08-07 16:12 ` [PATCH v3 1/2] DynamicTablesPkg: Fix issues reported by EDKII CI Sami Mujawar
2020-08-07 16:12 ` Sami Mujawar [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200807161205.50468-3-sami.mujawar@arm.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox