chiark / gitweb /
README.md: Config reference: misc.online
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Fri, 19 Jun 2020 12:39:42 +0000 (13:39 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Fri, 19 Jun 2020 12:39:42 +0000 (13:39 +0100)
Reported-by: Mark Wooding <mdw@distorted.org.uk>
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
README.md

index e9bd358d056f772b78b4d02ccfd602f52669629d..8996a661ab4011855cb48b5abdec1a2df725129f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -221,8 +221,8 @@ Command-line options
 
        Whether to allow cargo to make network access.  nailing-cargo
        always passes `--offline` to cargo, unless `--online` is in
-       force.  The default is offline, unless the cargo subcommand is
-       one which implies online (currently, `fetch`).
+       force.  The default value depends on the configuration and the
+       cargo subcommand - see `[misc]` `online` in "Configuration".
 
 Configuration
 =============
@@ -338,7 +338,16 @@ names.  The keys are the aliases; each entry should be a string, the
 cargo architecture name.
 
 Only keys starting with an ascii uppercase letter are relevant, since
-all other names are not looked up in this alias map.
+other names are not looked up in this alias map.
+
+`[misc]`: Miscellaneous individual nailing-cargo config
+-------------------------------------------------------
+
+ * `online`: boolean, specifying whether to pass `--offline` to cargo
+   (cargo's default is online mode).  The default is offline, unless
+   nailing-cargo can see that the cargo subcommand being invoked is
+   one which requires online access (currently, `fetch`), in which
+   case the default is online.
 
 Running the command
 ===================