Skip to content

Edk2 update

edk2_update

Updates external dependencies.

Contains a UpdateSettingsManager that must be subclassed in a build settings file. This provides platform specific information to Edk2Update invocable while allowing the invocable itself to remain platform agnostic.

UpdateSettingsManager

Platform specific settings for Edk2Update.

Provides information necessary for stuart_update.exe or edk2_update.py when updating the platform.

Update settings manager has no additional APIs not already defined in it's super class, however The class should still be overwritten by the platform.

Edk2Update

Updates dependencies in workspace for active scopes.

PerformUpdate

PerformUpdate() -> tuple

Updates the dependencies.

GetVerifyCheckRequired

GetVerifyCheckRequired() -> bool

Will not call self_describing_environment.VerifyEnvironment because ext_deps haven't been unpacked yet.

GetSettingsClass

GetSettingsClass() -> type

Returns the UpdateSettingsManager class.

Warning

UpdateSettingsManager must be subclassed in your platform settings file.

GetLoggingFileName

GetLoggingFileName(loggerType: str) -> str

Returns the filename (UPDATE_LOG) of where the logs for the Edk2CiBuild invocable are stored in.

AddCommandLineOptions

AddCommandLineOptions(
    parserObj: argparse.ArgumentParser,
) -> None

Adds command line options to the argparser.

RetrieveCommandLineOptions

RetrieveCommandLineOptions(
    args: argparse.Namespace,
) -> None

Retrieve command line options from the argparser.

Go

Go() -> int

Executes the core functionality of the Edk2Update invocable.

build_env_changed

build_env_changed(
    build_env: self_describing_environment.self_describing_environment,
    build_env_2: self_describing_environment.self_describing_environment,
) -> bool

Return True if build_env has changed.

main

main() -> None

Entry point to invoke Edk2Update.