tools/manifestfile.py: Optional includes and include-directory.

jimmo · jimmo · commit 6f7aed03a9ad · 2022-08-10T22:46:37.000+10:00
Simplifies the "include manifest if it exists" pattern used by a few
boards.

If an include path is a directory, then it implicitly grabs the manifest.py
file inside that directory. This simplifies most manifest.py files.

Signed-off-by: Jim Mussared &lt;jim.mussared@gmail.com&gt;
diff --git a/tools/manifestfile.py b/tools/manifestfile.py
@@ -196,6 +196,13 @@ def _search(
             if base_path:
                 os.chdir(prev_cwd)
 
+    def include_maybe(self, manifest_path, **kwargs):
+        """
+        Include the manifest file if it exists. See docs for include().
+        """
+        if os.path.exists(manifest_path):
+            self.include(manifest_path, **kwargs)
+
     def include(self, manifest_path, **kwargs):
         """
         Include another manifest.
@@ -205,6 +212,9 @@ def include(self, manifest_path, **kwargs):
 
         Relative paths are resolved with respect to the current manifest file.
 
+        If the path is to a directory, then it implicitly includes the
+        manifest.py file inside that directory.
+
         Optional kwargs can be provided which will be available to the
         included script via the `options` variable.
 
@@ -224,6 +234,9 @@ def include(self, manifest_path, **kwargs):
                 self.include(m)
         else:
             manifest_path = self._resolve_path(manifest_path)
+            # Including a directory grabs the manifest.py inside it.
+            if os.path.isdir(manifest_path):
+                manifest_path = os.path.join(manifest_path, "manifest.py")
             if manifest_path in self._visited:
                 return
             self._visited.add(manifest_path)
