Cleanup

docs/user/integrate/reporting.md

@@ -68,4 +68,4 @@ parser conflicts between platform added arguments and default arguments, that wi
 `Stuart_report` is a standalone command line tool that is not need to be associated with a python settings file. It
 only needs access to the database. Out of convenience, it assumes the database exists where `stuart_report` generates
 it in the workspace, however you can override that with the `-db` command line argument. Simply run `stuart_report -h`
-to view all reports, or review [TODO] TODO.
+to view all reports, or review [Using Reports](/using/reporting/)

edk2toolext/edk2_report.py

@@ -1,4 +1,4 @@
-# @file report_generator.py
+# @file edk2_report.py
 # An executable that allows a user to select a report and execute it on a given database.
 ##
 # Copyright (c) Microsoft Corporation

edk2toolext/environment/reporttypes/component_report.py

@@ -1,5 +1,5 @@
-# @file component_query.py
-# A query to print information about a component that could be compiled.
+# @file component_report.py
+# A report to print information about a component that could be compiled.
 ##
 # Copyright (c) Microsoft Corporation
 #

edk2toolext/environment/reporttypes/templates/usage_report_template.html

@@ -124,4 +124,4 @@ <h5 class="card-header">INF Information</h5>
         });
     </script>
 </body>
-</html>
+</html>

edk2toolext/environment/reporttypes/usage_report.py

@@ -7,7 +7,7 @@
 #
 # SPDX-License-Identifier: BSD-2-Clause-Patent
 ##
-"""A report that generates an html report about which repositories INFs origin from."""
+"""A report that generates an html report about which repositories INFs originate from."""
 import io
 import logging
 from argparse import ArgumentParser, Namespace

edk2toolext/invocables/edk2_parse.py

@@ -32,7 +32,6 @@
 
 DB_NAME = "DATABASE.db"
 
-
 TABLES = [
     PackageTable(),
     SourceTable(),
@@ -166,8 +165,6 @@ def parse_with_builder_settings(self, db: Edk2DB, pathobj: Edk2Path, env: VarDic
 
     def parse_with_ci_settings(self, db: Edk2DB, pathobj: Edk2Path, env: VarDict):
         """Parses the workspace using ci settings to setup the environment."""
-        # Build a list of Parsers to run with the expected settings.
-        # The same parser will exist for each package, with that package's settings.
         for package in self.requested_package_list:
             for target in set(self.requested_target_list) & set(["DEBUG", "RELEASE"]):
                 logging.info(f"Setting up the environment for {package}.")

pyproject.toml

@@ -10,7 +10,7 @@ description = "Python tools supporting UEFI EDK2 firmware development"
 readme = {file = "readme.md", content-type = "text/markdown"}
 license = {file = "LICENSE"}
 dependencies = [
-    "edk2-pytool-library>=0.18.0",
+    "edk2-pytool-library>=0.18.1",
     "pyyaml>=6.0.0",
     "pefile>=2023.2.7",
     "semantic_version>=2.10.0",