From c2154d4c8422ddc1c201d503bb52edff854af2ad Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Thu, 31 Aug 2017 14:28:25 +0200 Subject: Rename a few configuration options In particular, drop the "build-" and "gc-" prefixes which are pointless. So now you can say nix build --no-sandbox instead of nix build --no-build-use-sandbox --- doc/manual/command-ref/conf-file.xml | 57 +++++++++++++++++------------------ doc/manual/command-ref/nix-store.xml | 4 +-- doc/manual/command-ref/opt-common.xml | 8 ++--- 3 files changed, 34 insertions(+), 35 deletions(-) (limited to 'doc') diff --git a/doc/manual/command-ref/conf-file.xml b/doc/manual/command-ref/conf-file.xml index 47ceff2625ea..6b90083f0873 100644 --- a/doc/manual/command-ref/conf-file.xml +++ b/doc/manual/command-ref/conf-file.xml @@ -45,13 +45,12 @@ Comments start with a # character. Here is an example configuration file: -gc-keep-outputs = true # Nice for developers -gc-keep-derivations = true # Idem -env-keep-derivations = false +keep-outputs = true # Nice for developers +keep-derivations = true # Idem You can override settings on the command line using the - flag, e.g. --option gc-keep-outputs + flag, e.g. --option keep-outputs false. The following settings are currently available: @@ -59,7 +58,7 @@ false. - gc-keep-outputs + keep-outputs If true, the garbage collector will keep the outputs of non-garbage derivations. If @@ -76,7 +75,7 @@ false. - gc-keep-derivations + keep-derivations If true (default), the garbage collector will keep the derivations from which non-garbage store @@ -88,12 +87,12 @@ false. traceability (e.g., it allows you to ask with what dependencies or options a store path was built), so by default this option is on. Turn it off to save a bit of disk space (or a lot if - gc-keep-outputs is also turned on). + keep-outputs is also turned on). - env-keep-derivations + keep-env-derivations If false (default), derivations are not stored in Nix user environments. That is, the derivation @@ -105,19 +104,19 @@ false. garbage-collected until the user environment generation is deleted (nix-env --delete-generations). To prevent build-time-only dependencies from being collected, you should also - turn on gc-keep-outputs. + turn on keep-outputs. The difference between this option and - gc-keep-derivations is that this one is + keep-derivations is that this one is “sticky”: it applies to any user environment created while this - option was enabled, while gc-keep-derivations + option was enabled, while keep-derivations only applies at the moment the garbage collector is run. - build-max-jobs + max-jobs This option defines the maximum number of jobs that Nix will try to build in parallel. The default is @@ -130,7 +129,7 @@ false. - build-cores + cores Sets the value of the NIX_BUILD_CORES environment variable in the @@ -149,7 +148,7 @@ false. - build-max-silent-time + max-silent-time @@ -170,7 +169,7 @@ false. - build-timeout + timeout @@ -190,7 +189,7 @@ false. - build-max-log-size + max-build-log-size @@ -245,7 +244,7 @@ false. - build-use-sandbox + sandbox If set to true, builds will be performed in a sandboxed environment, i.e., @@ -254,7 +253,7 @@ false. directory, private versions of /proc, /dev, /dev/shm and /dev/pts (on Linux), and the paths configured with the - build-sandbox-paths + sandbox-paths option. This is useful to prevent undeclared dependencies on files in directories such as /usr/bin. In addition, on Linux, builds run in private PID, mount, network, IPC @@ -280,8 +279,8 @@ false. - - build-sandbox-paths + + sandbox-paths A list of paths bind-mounted into Nix sandbox environments. You can use the syntax @@ -303,17 +302,17 @@ false. - + build-extra-sandbox-paths A list of additional paths appended to - . Useful if you want to extend + . Useful if you want to extend its default value. - build-use-substitutes + use-substitutes If set to true (default), Nix will use binary substitutes if available. This option can be @@ -322,7 +321,7 @@ false. - build-fallback + fallback If set to true, Nix will fall back to building from source if a binary substitute fails. This @@ -332,7 +331,7 @@ false. - build-keep-log + keep-build-log If set to true (the default), Nix will write the build log of a derivation (i.e. the standard @@ -344,7 +343,7 @@ false. - build-compress-log + compress-build-log If set to true (the default), build logs written to /nix/var/log/nix/drvs @@ -597,7 +596,7 @@ password my-password Pass a list of files and directories to be included in the sandbox for this build. One entry per line, terminated by an empty line. Entries have the same format as - build-sandbox-paths. + sandbox-paths. @@ -608,7 +607,7 @@ password my-password - build-repeat + repeat How many times to repeat builds to check whether they are deterministic. The default value is 0. If the value is @@ -651,7 +650,7 @@ password my-password as sudo or ping will fail. (Note that in sandbox builds, no such programs are available unless you bind-mount them into the sandbox via the - option.) You can allow the + option.) You can allow the use of such programs by enabling this option. This is impure and usually undesirable, but may be useful in certain scenarios (e.g. to spin up containers or set up userspace network interfaces diff --git a/doc/manual/command-ref/nix-store.xml b/doc/manual/command-ref/nix-store.xml index 19c99841a0ac..a5f615b0c268 100644 --- a/doc/manual/command-ref/nix-store.xml +++ b/doc/manual/command-ref/nix-store.xml @@ -397,9 +397,9 @@ options control what gets deleted and in what order: The behaviour of the collector is also influenced by the gc-keep-outputs +linkend="conf-keep-outputs">keep-outputs and gc-keep-derivations +linkend="conf-keep-derivations">keep-derivations variables in the Nix configuration file. With , the collector prints the total diff --git a/doc/manual/command-ref/opt-common.xml b/doc/manual/command-ref/opt-common.xml index a930b4a0d781..32d53c753a22 100644 --- a/doc/manual/command-ref/opt-common.xml +++ b/doc/manual/command-ref/opt-common.xml @@ -94,7 +94,7 @@ perform in parallel to the specified number. Specify auto to use the number of CPUs in the system. The default is specified by the build-max-jobs + linkend='conf-max-jobs'>max-jobs configuration setting, which itself defaults to 1. A higher value is useful on SMP systems or to exploit I/O latency. @@ -112,7 +112,7 @@ true, the builder passes the flag to GNU Make. It defaults to the value of the build-cores + linkend='conf-cores'>cores configuration setting, if set, or 1 otherwise. The value 0 means that the builder should use all available CPU cores in the system. @@ -125,7 +125,7 @@ Sets the maximum number of seconds that a builder can go without producing any data on standard output or standard error. The default is specified by the build-max-silent-time + linkend='conf-max-silent-time'>max-silent-time configuration setting. 0 means no time-out. @@ -135,7 +135,7 @@ Sets the maximum number of seconds that a builder can run. The default is specified by the build-timeout + linkend='conf-timeout'>timeout configuration setting. 0 means no timeout. -- cgit 1.4.1