improve verbosity flag override (#938)

Improves the verbosity command line argument for stuart commands in the following ways:

Moves when the flag is registered, so that the flag can be seen with the --help flag, even if a configuration file is not used.
Passes the verbosity flag to the edk2 build command.
Additionally, as a part of (2), platforms can now also control verbosity of EDKII Build in their platform configuration files via the EDK2_BUILD_VERBOSE env variable.

edk2toolext/edk2_invocable.py

@@ -410,9 +410,21 @@ def ParseCommandLineOptions(self) -> None:
             help="Provide the Platform Module relative to the current working directory."
             f"This should contain a {self.GetSettingsClass().__name__} instance.",
         )
+        settingsParserObj.add_argument(
+            "--verbose",
+            "--VERBOSE",
+            "-v",
+            dest="verbose",
+            action="store_true",
+            default=False,
+            help="Overrides platform module settings and sets all loggers to to the highest verbosity, including EDKII build command if applicable.",
+        )
 
         # get the settings manager from the provided file and load an instance
         settingsArg, unknown_args = settingsParserObj.parse_known_args()
+
+        self.Verbose = settingsArg.verbose
+
         try:
             self.PlatformModule = import_module_by_file_name(os.path.abspath(settingsArg.platform_module))
             self.PlatformSettings = locate_class_in_module(self.PlatformModule, self.GetSettingsClass())()
@@ -487,30 +499,26 @@ def ParseCommandLineOptions(self) -> None:
             type=str,
             help="Provide shell variables in a file",
         )
-        parserObj.add_argument(
-            "--verbose",
-            "--VERBOSE",
-            "-v",
-            dest="verbose",
-            action="store_true",
-            default=False,
-            help="Overrides platform settings and sets all loggers to verbose (logging.DEBUG).",
-        )
 
         # set the epilog to display with --help, -h
         parserObj.epilog = self.AddParserEpilog()
 
         # setup sys.argv and argparse round 2
         sys.argv = [sys.argv[0]] + (["--help"] if settingsArg.help else unknown_args)
         args, unknown_args = parserObj.parse_known_args()
-        self.Verbose = args.verbose
 
         # give the parsed args to the subclass
         self.RetrieveCommandLineOptions(args)
 
         # give the parsed args to platform settings manager
         self.PlatformSettings.RetrieveCommandLineOptions(args)
 
+        env = shell_environment.GetBuildVars()
+
+        # Override the verbose settings if the command line option is set
+        if self.Verbose:
+            env.SetValue("EDK2_BUILD_VERBOSE", "TRUE", "From CmdLine")
+
         #
         # Look through unknown_args and BuildConfig for strings that are:
         # 1. x=y, -> set env.SetValue(x, y),
@@ -522,7 +530,6 @@ def ParseCommandLineOptions(self) -> None:
         # check for the existence of the build variable rather then the value
         # of the variable. This is to have parity between edk2's build -D
         # flag and stuart.
-        env = shell_environment.GetBuildVars()
         BuildConfig = os.path.abspath(args.build_config)
 
         for argument in unknown_args:

edk2toolext/environment/uefi_build.py

@@ -75,6 +75,7 @@ def __init__(self) -> None:
         self.Clean = False
         self.UpdateConf = False
         self.OutputConfig = None
+        self.Verbose = False
 
     def AddPlatformCommandLineOptions(self, parserObj: argparse.ArgumentParser) -> None:
         """Adds command line options to the argparser.
@@ -344,6 +345,10 @@ def Build(self) -> int:
         params = "-p " + self.env.GetValue("ACTIVE_PLATFORM")
         params += " -b " + BuildType
         params += " -t " + self.env.GetValue("TOOL_CHAIN_TAG")
+
+        if self.env.GetValue("EDK2_BUILD_VERBOSE") == "TRUE":
+            params += " --verbose"
+
         # Thread number is now optional and not set in default tianocore target.txt
         if self.env.GetValue("MAX_CONCURRENT_THREAD_NUMBER") is not None:
             params += " -n " + self.env.GetValue("MAX_CONCURRENT_THREAD_NUMBER")