aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/src/command-ref
diff options
context:
space:
mode:
authorValentin Gagarin <valentin.gagarin@tweag.io>2023-06-20 12:12:23 +0200
committerValentin Gagarin <valentin.gagarin@tweag.io>2023-06-20 12:13:32 +0200
commit68c62193439ec90d34a7988c6a1a73b3e553a435 (patch)
treeeb0d4642d3b7da9bd002275b7a1c0d509c999b4d /doc/manual/src/command-ref
parentbc7324e912578cdbeb1f10bf1c8d9b447a416dbd (diff)
clarify setting options on the command line
Diffstat (limited to 'doc/manual/src/command-ref')
-rw-r--r--doc/manual/src/command-ref/conf-file-prefix.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/doc/manual/src/command-ref/conf-file-prefix.md b/doc/manual/src/command-ref/conf-file-prefix.md
index 3cd622247..1e4085977 100644
--- a/doc/manual/src/command-ref/conf-file-prefix.md
+++ b/doc/manual/src/command-ref/conf-file-prefix.md
@@ -49,12 +49,22 @@ extra-substituters = c d
defines the `substituters` setting to be `a b c d`.
+Unknown option names are not an error, and are simply ignored with a warning.
+
## Command line flags
-Every configuration setting has a corresponding command line flag (e.g. `--max-jobs 16`).
-Boolean settings do not need an argument, and can be explicitly disabled with the `no-` prefix (e.g. `--keep-failed` and `--no-keep-failed`).
+Configuration options can be set on the command line, overriding the values set in the [configuration file](#configuration-file):
+
+- Every configuration setting has corresponding command line flag (e.g. `--max-jobs 16`).
+ Boolean settings do not need an argument, and can be explicitly disabled with the `no-` prefix (e.g. `--keep-failed` and `--no-keep-failed`).
+
+ Unknown option names are invalid flags (unless there is already a flag with that name), and are rejected with an error.
+
+- The flag `--option <name> <value>` is interpreted exactly like a `<name> = <value>` in a setting file.
+
+ Unknown option names are ignored with a warning.
-Existing settings can be appended to using the `extra-` prefix (e.g. `--extra-substituters`).
+The `extra-` prefix is supported for settings that take a list of items (e.g. `--extra-trusted users alice` or `--option extra-trusted-users alice`).
# Available settings