diff options
author | 2023-10-10 14:33:42 +0000 | |
---|---|---|
committer | 2023-10-10 14:33:42 +0000 | |
commit | af1a266670d040d2f4083ff309d732d648afba2a (patch) | |
tree | 2fc46203448ddcc6f81546d379abfaeb323575e9 /roms/edk2/.pytool/Plugin/HostUnitTestCompilerPlugin/Readme.md | |
parent | e02cda008591317b1625707ff8e115a4841aa889 (diff) |
Change-Id: Iaf8d18082d3991dec7c0ebbea540f092188eb4ec
Diffstat (limited to 'roms/edk2/.pytool/Plugin/HostUnitTestCompilerPlugin/Readme.md')
-rw-r--r-- | roms/edk2/.pytool/Plugin/HostUnitTestCompilerPlugin/Readme.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/roms/edk2/.pytool/Plugin/HostUnitTestCompilerPlugin/Readme.md b/roms/edk2/.pytool/Plugin/HostUnitTestCompilerPlugin/Readme.md new file mode 100644 index 000000000..3eeebb4b1 --- /dev/null +++ b/roms/edk2/.pytool/Plugin/HostUnitTestCompilerPlugin/Readme.md @@ -0,0 +1,24 @@ +# Host UnitTest Compiler Plugin
+
+A CiBuildPlugin that compiles the dsc for host based unit test apps.
+An IUefiBuildPlugin may be attached to this plugin that will run the unit tests and collect the results after successful compilation.
+
+## Configuration
+
+The package relative path of the DSC file to build.
+
+``` yaml
+"HostUnitTestCompilerPlugin": {
+ "DscPath": "<path to dsc from root of pkg>"
+}
+```
+
+### DscPath
+
+Package relative path to the DSC file to build.
+
+## Copyright
+
+Copyright (c) Microsoft Corporation.
+SPDX-License-Identifier: BSD-2-Clause-Patent
+
|