Add --work-root command line option for overriding build-root

Author: erikwa

fusesoc/config.py

@@ -159,6 +159,14 @@ def build_root(self):
     def build_root(self, val):
         self._set_default_section("build_root", val)
 
+    @property
+    def work_root(self):
+        return self._arg_or_val("args_work_root", self._path_from_cfg("work_root"))
+
+    @work_root.setter
+    def work_root(self, val):
+        self._set_default_section("work_root", val)
+
     @property
     def cache_root(self):
         return self._get_cache_root()

fusesoc/fusesoc.py

@@ -92,7 +92,7 @@ def get_work_root(self, core, flags):
 
         if flow:
             logger.debug(f"Using flow API (flow={flow})")
-            work_root = os.path.join(build_root, target)
+            work_root = self.config.work_root or os.path.join(build_root, target)
         else:
             logger.debug("flow not set. Falling back to tool API")
             if "tool" in flags:
@@ -101,7 +101,9 @@ def get_work_root(self, core, flags):
                 tool_error = "No flow or tool was supplied on command line or found in '{}' core description"
                 raise RuntimeError(tool_error.format(core.name.sanitized_name))
 
-            work_root = os.path.join(build_root, f"{target}-{tool}")
+            work_root = self.config.work_root or os.path.join(
+                build_root, f"{target}-{tool}"
+            )
 
         return work_root
 

fusesoc/main.py

@@ -538,7 +538,12 @@ def get_parser():
         help="Reference source files from their current location instead of exporting to a build tree",
     )
     parser_run.add_argument(
-        "--build-root", help="Output directory for build. Defaults to build/$VLNV"
+        "--build-root",
+        help="Output directory for build. VLNV will be appended (defaults to build/)",
+    )
+    parser_run.add_argument(
+        "--work-root",
+        help="Output directory for build. VLNV will not be appended (overrides build-root)",
     )
     parser_run.add_argument("--setup", action="store_true", help="Execute setup stage")
     parser_run.add_argument("--build", action="store_true", help="Execute build stage")
@@ -617,6 +622,9 @@ def args_to_config(args, config):
     if hasattr(args, "build_root") and args.build_root and len(args.build_root) > 0:
         setattr(config, "args_build_root", args.build_root)
 
+    if hasattr(args, "work_root") and args.work_root and len(args.work_root) > 0:
+        setattr(config, "args_work_root", args.work_root)
+
     if hasattr(args, "cores_root") and args.cores_root and len(args.cores_root) > 0:
         setattr(config, "args_cores_root", args.cores_root)