]> git.ipfire.org Git - thirdparty/mkosi.git/commitdiff
man: mention the empty arguments in help
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Mon, 26 Aug 2024 16:08:43 +0000 (19:08 +0300)
committerDaan De Meyer <daan.j.demeyer@gmail.com>
Tue, 27 Aug 2024 08:13:20 +0000 (10:13 +0200)
The autogenerated help for --distribution/--format/… looks like {a,b,…,} (with
an emtpy arg at the end), and it is not obvious what this means. Describe the
empty args in the man page.

mkosi/resources/mkosi.md

index b34fda45628919483920f185b01814c1e0453461..b2ab11a5479cd576bffac9923f1ff895c9b4c83b 100644 (file)
@@ -284,9 +284,9 @@ grouped by section below.
 
 Configuration is parsed in the following order:
 
-* The command line arguments are parsed
-* `mkosi.local.conf` is parsed if it exists. This file should be in the
-  gitignore (or equivalent) and is intended for local configuration.
+* The command line arguments are parsed.
+* `mkosi.local.conf` is parsed if it exists. This file should be in
+  `.gitignore` (or equivalent) and is intended for local configuration.
 * Any default paths (depending on the option) are configured if the
   corresponding path exists.
 * `mkosi.conf` is parsed if it exists in the directory configured with
@@ -305,9 +305,13 @@ settings configured via configuration files. If the same setting is
 configured more than once via configuration files, later assignments
 override earlier assignments except for settings that take a collection
 of values. Also, settings read from `mkosi.local.conf` will override
-settings from configuration files that are parsed later but not settings
+settings from configuration files that are parsed later, but not settings
 specified on the CLI.
 
+For settings that take a single value, the empty assignment (`SomeSetting=` or
+`--some-setting=`) can be used to override a previous setting and reset to the
+default.
+
 Settings that take a collection of values are merged by appending the
 new values to the previously configured values. Assigning the empty
 string to such a setting removes all previously assigned values, and