Don't chdir() to mkosi/ subdirectory

Changing the working directory to mkosi/ is not intuitive. We want
to parse configuration from there, but the working directory should
not change (e.g. you don't want mkosi sandbox to execute inside the
mkosi/ subdirectory when invoked in the top level directory).

diff --git a/mkosi/config.py b/mkosi/config.py
index d7692f88c300f2192855d91455093c0086201306..9b5e844ac07690a4cc6398b4aa9bc077822153d3 100644 (file)
--- a/mkosi/config.py
+++ b/mkosi/config.py
@@ -4911,7 +4911,13 @@ def have_history(args: Args) -> bool:
     )
 
 
-def finalize_default_tools(main: ParseContext, finalized: dict[str, Any], *, resources: Path) -> Config:
+def finalize_default_tools(
+    main: ParseContext,
+    finalized: dict[str, Any],
+    *,
+    configdir: Path,
+    resources: Path,
+) -> Config:
     context = ParseContext(resources)
 
     for s in SETTINGS:
@@ -4946,7 +4952,7 @@ def finalize_default_tools(main: ParseContext, finalized: dict[str, Any], *, res
         for name in finalized.get("environment", {}).keys() & finalized.get("pass_environment", [])
     }
 
-    if (p := Path("mkosi.tools.conf").absolute()).exists():
+    if (p := configdir / "mkosi.tools.conf").exists():
         with chdir(p if p.is_dir() else Path.cwd()):
             context.parse_config_one(p, parse_profiles=p.is_dir(), parse_local=p.is_dir())
 
@@ -4999,16 +5005,6 @@ def parse_config(
     if not args.verb.needs_config():
         return args, None, ()
 
-    # Allow locating all mkosi configuration in a mkosi/ subdirectory instead of in the top-level directory
-    # of a git repository.
-    if (
-        args.directory is not None
-        and not (Path("mkosi.conf").exists() or Path("mkosi.tools.conf").exists())
-        and (Path("mkosi/mkosi.conf").is_file() or Path("mkosi/mkosi.tools.conf").exists())
-    ):
-        os.chdir(args.directory / "mkosi")
-        args = dataclasses.replace(args, directory=args.directory / "mkosi")
-
     if have_history(args):
         try:
             j = json.loads(Path(".mkosi-private/history/latest.json").read_text())
@@ -5052,9 +5048,21 @@ def parse_config(
 
     context.config["files"] = []
 
+    # Allow locating all mkosi configuration in a mkosi/ subdirectory instead of in the top-level directory
+    # of a git repository.
+    if (
+        args.directory is not None
+        and not (Path("mkosi.conf").exists() or Path("mkosi.tools.conf").exists())
+        and (Path("mkosi/mkosi.conf").is_file() or Path("mkosi/mkosi.tools.conf").exists())
+    ):
+        configdir = Path.cwd() / "mkosi"
+    else:
+        configdir = Path.cwd()
+
     # Parse the global configuration unless the user explicitly asked us not to.
     if args.directory is not None:
-        context.parse_config_one(Path.cwd(), parse_profiles=True, parse_local=True)
+        with chdir(configdir):
+            context.parse_config_one(configdir, parse_profiles=True, parse_local=True)
 
     config = context.finalize()
 
@@ -5062,7 +5070,7 @@ def parse_config(
         return args, tools, (*subimages, Config.from_dict(config))
 
     if config.get("tools_tree") == Path("default"):
-        tools = finalize_default_tools(context, config, resources=resources)
+        tools = finalize_default_tools(context, config, configdir=configdir, resources=resources)
         config["tools_tree"] = tools.output_dir_or_cwd() / tools.output
 
     images = []
@@ -5077,7 +5085,7 @@ def parse_config(
         None if "dependencies" in context.cli or "dependencies" in context.config else []
     )
 
-    if args.directory is not None and Path("mkosi.images").exists():
+    if args.directory is not None and (imagedir := configdir / "mkosi.images").exists():
         # For the subimages in mkosi.images/, we want settings that are marked as
         # "universal" to override whatever settings are specified in the subimage
         # configuration files. We achieve this by making it appear like these settings
@@ -5089,7 +5097,7 @@ def parse_config(
             elif s.dest in context.cli:
                 del context.cli[s.dest]
 
-        for p in sorted(Path("mkosi.images").iterdir()):
+        for p in sorted(imagedir.iterdir()):
             p = p.absolute()
 
             if not p.is_dir() and not p.suffix == ".conf":

diff --git a/mkosi/resources/man/mkosi.1.md b/mkosi/resources/man/mkosi.1.md
index a0b673a2b7b32d5bba45f9522e0a704d7a24e5dc..80319847e29d3e5e62de718a7042814f89fbb1a3 100644 (file)
--- a/mkosi/resources/man/mkosi.1.md
+++ b/mkosi/resources/man/mkosi.1.md
@@ -252,11 +252,6 @@ Those settings cannot be configured in the configuration files.
     working directory. If the empty string is specified, all configuration in
     the current working directory will be ignored.
 
-:   If the specified directory does not contain a `mkosi.conf` or
-    `mkosi.tools.conf` and a `mkosi/mkosi.conf` or `mkosi/mkosi.tools.conf`
-    exists, the `mkosi/` subdirectory of the specified directory will be
-    used instead.
-
 `--debug`
 :   Enable additional debugging output.
 
@@ -355,14 +350,17 @@ Configuration is parsed in the following order:
   corresponding path exists.
 * `mkosi.conf` is parsed if it exists in the directory configured with
   `--directory=` or the current working directory if `--directory=` is
-  not used.
-* `mkosi.conf.d/` is parsed in the same directory if it exists. Each
-  directory and each file with the `.conf` extension in `mkosi.conf.d/`
-  is parsed. Any directory in `mkosi.conf.d` is parsed as if it were
-  a regular top level directory.
+  not used. If the specified directory does not contain a `mkosi.conf` or
+  `mkosi.tools.conf` and a `mkosi/mkosi.conf` or `mkosi/mkosi.tools.conf`
+  exists, the configuration will be parsed from the `mkosi/`
+  subdirectory of the specified directory instead.
+* `mkosi.conf.d/` is parsed in the same directory as `mkosi.conf` if it
+  exists. Each directory and each file with the `.conf` extension in
+  `mkosi.conf.d/` is parsed. Any directory in `mkosi.conf.d` is parsed
+  as if it were a regular top level directory.
 * If any profiles are configured, their configuration is parsed from the
   `mkosi.profiles/` directory.
-* Subimages are parsed from the `mkosi.images` directory if it exists.
+* Subimages are parsed from the `mkosi.images/` directory if it exists.
 
 Note that settings configured via the command line always override
 settings configured via configuration files. If the same setting is