Skip to content

Commit 3584b5b

Browse files
makubackiJavagedes
authored andcommitted
edk2_pr_eval: Update PrEvalSettingsManager.GetPlatformDscAndConfig description
Describe the API in more detail to clarify how it is used. Signed-off-by: Michael Kubacki <[email protected]>
1 parent 0b43a7d commit 3584b5b

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

edk2toolext/invocables/edk2_pr_eval.py

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,22 @@ def FilterPackagesToTest(self, changedFilesList: list, potentialPackagesList: li
8383
return potentialPackagesList
8484

8585
def GetPlatformDscAndConfig(self) -> tuple:
86-
"""Provide a platform dsc and config.
86+
"""Provide a platform DSC and build variable configuration.
8787
88-
If a platform desires to provide its DSC then Policy 4 will evaluate if
89-
any of the changes will be built in the dsc.
88+
If a platform provides the workspace relative path for its DSC file to this function, then
89+
Policy 4 will be evaluated. This is used to determine if a change occurred in a module that
90+
is used in the DSC file.
91+
92+
Returning the dictionary of build key value pairs is optional but allows those variables to
93+
be considered when evaluating the DSC file. These variable values will override any values
94+
set directly in build files such as the DSC files. These variable values will be overridden
95+
by any values set on the command line for the current target.
9096
9197
!!! tip
92-
Optional Override in a subclass
98+
Optional override in a subclass
9399
94100
Returns:
95-
(tuple): (workspace relative path to dsc file, input dictionary of dsc key value pairs)
101+
(tuple): (workspace relative path to DSC file, input dictionary of build variable key value pairs)
96102
"""
97103
return None
98104

0 commit comments

Comments
 (0)