From c20c0823838d257b1e18e71c307f53afac0d2b39 Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Thu, 23 Jul 2020 10:38:19 +0200 Subject: [PATCH] -> --- doc/manual/advanced-topics/cores-vs-jobs.xml | 10 +++--- .../advanced-topics/distributed-builds.xml | 2 +- doc/manual/command-ref/conf-file.xml | 20 +++++------ doc/manual/command-ref/env-common.xml | 34 +++++++++---------- doc/manual/command-ref/nix-copy-closure.xml | 2 +- doc/manual/command-ref/nix-env.xml | 4 +-- doc/manual/command-ref/nix-instantiate.xml | 4 +-- doc/manual/command-ref/nix-shell.xml | 10 +++--- doc/manual/command-ref/nix-store.xml | 2 +- doc/manual/command-ref/opt-common.xml | 6 ++-- .../expressions/advanced-attributes.xml | 6 ++-- doc/manual/expressions/build-script.xml | 14 ++++---- doc/manual/expressions/derivations.xml | 16 ++++----- doc/manual/expressions/generic-builder.xml | 8 ++--- doc/manual/expressions/language-values.xml | 2 +- .../expressions/simple-building-testing.xml | 2 +- doc/manual/installation/env-variables.xml | 10 +++--- doc/manual/installation/installing-binary.xml | 2 +- doc/manual/installation/multi-user.xml | 2 +- doc/manual/introduction/about-nix.xml | 2 +- doc/manual/packages/basic-package-mgmt.xml | 2 +- doc/manual/packages/profiles.xml | 8 ++--- doc/manual/release-notes/rl-0.10.xml | 6 ++-- doc/manual/release-notes/rl-0.12.xml | 4 +-- doc/manual/release-notes/rl-0.16.xml | 2 +- doc/manual/release-notes/rl-1.0.xml | 2 +- doc/manual/release-notes/rl-1.2.xml | 2 +- doc/manual/release-notes/rl-1.6.xml | 2 +- doc/manual/release-notes/rl-1.8.xml | 2 +- doc/manual/release-notes/rl-1.9.xml | 6 ++-- doc/manual/release-notes/rl-2.0.xml | 22 ++++++------ doc/manual/release-notes/rl-2.2.xml | 4 +-- doc/manual/release-notes/rl-2.3.xml | 2 +- 33 files changed, 111 insertions(+), 111 deletions(-) diff --git a/doc/manual/advanced-topics/cores-vs-jobs.xml b/doc/manual/advanced-topics/cores-vs-jobs.xml index 4d58ac7c5..a75dea37f 100644 --- a/doc/manual/advanced-topics/cores-vs-jobs.xml +++ b/doc/manual/advanced-topics/cores-vs-jobs.xml @@ -31,13 +31,13 @@ they are, how they interact, and their configuration trade-offs. The setting determines the value of -NIX_BUILD_CORES. NIX_BUILD_CORES is equal +NIX_BUILD_CORES. NIX_BUILD_CORES is equal to , unless -equals 0, in which case NIX_BUILD_CORES +equals 0, in which case NIX_BUILD_CORES will be the total number of cores in the system. The maximum number of consumed cores is a simple multiplication, - * NIX_BUILD_CORES. + * NIX_BUILD_CORES. The balance on how to set these two independent variables depends upon each builder's workload and hardware. Here are a few example @@ -49,7 +49,7 @@ scenarios on a machine with 24 cores: - NIX_BUILD_CORES + NIX_BUILD_CORES Maximum Processes Result @@ -116,6 +116,6 @@ scenarios on a machine with 24 cores: It is up to the derivations' build script to respect host's requested cores-per-build by following the value of the -NIX_BUILD_CORES environment variable. +NIX_BUILD_CORES environment variable. diff --git a/doc/manual/advanced-topics/distributed-builds.xml b/doc/manual/advanced-topics/distributed-builds.xml index 9ac4a92cd..a649b6f8d 100644 --- a/doc/manual/advanced-topics/distributed-builds.xml +++ b/doc/manual/advanced-topics/distributed-builds.xml @@ -43,7 +43,7 @@ bash: nix-store: command not found error: cannot connect to 'mac' -then you need to ensure that the PATH of +then you need to ensure that the PATH of non-interactive login shells contains Nix. If you are building via the Nix daemon, it is the Nix diff --git a/doc/manual/command-ref/conf-file.xml b/doc/manual/command-ref/conf-file.xml index 1fa74a143..ff9c7d46c 100644 --- a/doc/manual/command-ref/conf-file.xml +++ b/doc/manual/command-ref/conf-file.xml @@ -25,20 +25,20 @@ sysconfdir/nix/nix.conf (i.e. /etc/nix/nix.conf on most systems), or $NIX_CONF_DIR/nix.conf if -NIX_CONF_DIR is set. Values loaded in this file are not forwarded to the Nix daemon. The +NIX_CONF_DIR is set. Values loaded in this file are not forwarded to the Nix daemon. The client assumes that the daemon has already loaded them. User-specific configuration files: - If NIX_USER_CONF_FILES is set, then each path separated by + If NIX_USER_CONF_FILES is set, then each path separated by : will be loaded in reverse order. Otherwise it will look for nix/nix.conf files in - XDG_CONFIG_DIRS and XDG_CONFIG_HOME. + XDG_CONFIG_DIRS and XDG_CONFIG_HOME. The default location is $HOME/.config/nix.conf if those environment variables are unset. @@ -195,8 +195,8 @@ false. If the build users group is empty, builds will be performed under the uid of the Nix process (that is, the uid of the caller - if NIX_REMOTE is empty, the uid under which the Nix - daemon runs if NIX_REMOTE is + if NIX_REMOTE is empty, the uid under which the Nix + daemon runs if NIX_REMOTE is daemon). Obviously, this should not be used in multi-user settings with untrusted users. @@ -231,7 +231,7 @@ false. cores Sets the value of the - NIX_BUILD_CORES environment variable in the + NIX_BUILD_CORES environment variable in the invocation of builders. Builders can use this variable at their discretion to control the maximum amount of parallelism. For instance, in Nixpkgs, if the derivation attribute @@ -694,7 +694,7 @@ password my-password - DRV_PATH + DRV_PATH The derivation for the built paths. Example: @@ -704,7 +704,7 @@ password my-password - OUT_PATHS + OUT_PATHS Output paths of the built derivation, separated by a space character. Example: @@ -754,7 +754,7 @@ password my-password If set to true, the Nix evaluator will not allow access to any files outside of the Nix search path (as - set via the NIX_PATH environment variable or the + set via the NIX_PATH environment variable or the option), or to URIs outside of . The default is false. @@ -958,7 +958,7 @@ requiredSystemFeatures = [ "kvm" ]; Nix caches tarballs in $XDG_CACHE_HOME/nix/tarballs. - Files fetched via NIX_PATH, + Files fetched via NIX_PATH, fetchGit, fetchMercurial, fetchTarball, and fetchurl respect this TTL. diff --git a/doc/manual/command-ref/env-common.xml b/doc/manual/command-ref/env-common.xml index 8466cc463..3196cbbd2 100644 --- a/doc/manual/command-ref/env-common.xml +++ b/doc/manual/command-ref/env-common.xml @@ -11,7 +11,7 @@ -IN_NIX_SHELL +IN_NIX_SHELL Indicator that tells if the current environment was set up by nix-shell. Since Nix 2.0 the values are @@ -19,7 +19,7 @@ -NIX_PATH +NIX_PATH @@ -50,7 +50,7 @@ nixpkgs=/home/eelco/Dev/nixpkgs-branch:/etc/nixos interpreted as the URL of a tarball that will be downloaded and unpacked to a temporary location. The tarball must consist of a single top-level directory. For example, setting - NIX_PATH to + NIX_PATH to nixpkgs=https://github.com/NixOS/nixpkgs/archive/nixos-15.09.tar.gz @@ -65,12 +65,12 @@ nixpkgs=https://github.com/NixOS/nixpkgs/archive/nixos-15.09.tar.gz The search path can be extended using the option, which takes precedence over - NIX_PATH. + NIX_PATH. -NIX_IGNORE_SYMLINK_STORE +NIX_IGNORE_SYMLINK_STORE @@ -84,7 +84,7 @@ nixpkgs=https://github.com/NixOS/nixpkgs/archive/nixos-15.09.tar.gz except when builds are deployed to machines where /nix/store resolves differently. If you are sure that you’re not going to do that, you can set - NIX_IGNORE_SYMLINK_STORE to 1. + NIX_IGNORE_SYMLINK_STORE to 1. Note that if you’re symlinking the Nix store so that you can put it on another file system than the root file system, on Linux @@ -102,7 +102,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix -NIX_STORE_DIR +NIX_STORE_DIR Overrides the location of the Nix store (default prefix/store). @@ -110,7 +110,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix -NIX_DATA_DIR +NIX_DATA_DIR Overrides the location of the Nix static data directory (default @@ -119,7 +119,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix -NIX_LOG_DIR +NIX_LOG_DIR Overrides the location of the Nix log directory (default prefix/var/log/nix). @@ -127,7 +127,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix -NIX_STATE_DIR +NIX_STATE_DIR Overrides the location of the Nix state directory (default prefix/var/nix). @@ -135,7 +135,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix -NIX_CONF_DIR +NIX_CONF_DIR Overrides the location of the system Nix configuration directory (default @@ -143,7 +143,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix -NIX_USER_CONF_FILES +NIX_USER_CONF_FILES Overrides the location of the user Nix configuration files to load from (defaults to the XDG spec locations). The variable is treated @@ -151,7 +151,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix -TMPDIR +TMPDIR Use the specified directory to store temporary files. In particular, this includes temporary build directories; @@ -161,7 +161,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix -NIX_REMOTE +NIX_REMOTE This variable should be set to daemon if you want to use the Nix daemon to @@ -174,7 +174,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix -NIX_SHOW_STATS +NIX_SHOW_STATS If set to 1, Nix will print some evaluation statistics, such as the number of values @@ -183,7 +183,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix -NIX_COUNT_CALLS +NIX_COUNT_CALLS If set to 1, Nix will print how often functions were called during Nix expression evaluation. This @@ -192,7 +192,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix -GC_INITIAL_HEAP_SIZE +GC_INITIAL_HEAP_SIZE If Nix has been configured to use the Boehm garbage collector, this variable sets the initial size of the heap in bytes. diff --git a/doc/manual/command-ref/nix-copy-closure.xml b/doc/manual/command-ref/nix-copy-closure.xml index e6dcf180a..8c07984fb 100644 --- a/doc/manual/command-ref/nix-copy-closure.xml +++ b/doc/manual/command-ref/nix-copy-closure.xml @@ -129,7 +129,7 @@ those paths. If this bothers you, use - NIX_SSHOPTS + NIX_SSHOPTS Additional options to be passed to ssh on the command line. diff --git a/doc/manual/command-ref/nix-env.xml b/doc/manual/command-ref/nix-env.xml index 55f25d959..4dedd90ca 100644 --- a/doc/manual/command-ref/nix-env.xml +++ b/doc/manual/command-ref/nix-env.xml @@ -277,7 +277,7 @@ also . A symbolic link to the user's current profile. By default, this symlink points to prefix/var/nix/profiles/default. - The PATH environment variable should include + The PATH environment variable should include ~/.nix-profile/bin for the user environment to be visible to the user. @@ -1485,7 +1485,7 @@ error: no generation older than the current (91) exists - NIX_PROFILE + NIX_PROFILE Location of the Nix profile. Defaults to the target of the symlink ~/.nix-profile, if it diff --git a/doc/manual/command-ref/nix-instantiate.xml b/doc/manual/command-ref/nix-instantiate.xml index 53f06aed1..4ff967ecf 100644 --- a/doc/manual/command-ref/nix-instantiate.xml +++ b/doc/manual/command-ref/nix-instantiate.xml @@ -106,10 +106,10 @@ input. Look up the given files in Nix’s search path (as - specified by the NIX_PATH + specified by the NIX_PATH environment variable). If found, print the corresponding absolute paths on standard output. For instance, if - NIX_PATH is + NIX_PATH is nixpkgs=/home/alice/nixpkgs, then nix-instantiate --find-file nixpkgs/default.nix will print diff --git a/doc/manual/command-ref/nix-shell.xml b/doc/manual/command-ref/nix-shell.xml index 2fef323c5..de9755d58 100644 --- a/doc/manual/command-ref/nix-shell.xml +++ b/doc/manual/command-ref/nix-shell.xml @@ -141,8 +141,8 @@ also . almost entirely cleared before the interactive shell is started, so you get an environment that more closely corresponds to the “real” Nix build. A few variables, in particular - HOME, USER and - DISPLAY, are retained. Note that + HOME, USER and + DISPLAY, are retained. Note that ~/.bashrc and (depending on your Bash installation) /etc/bashrc are still sourced, so any variables set there will affect the interactive @@ -193,10 +193,10 @@ also . - NIX_BUILD_SHELL + NIX_BUILD_SHELL Shell used to start the interactive environment. - Defaults to the bash found in PATH. + Defaults to the bash found in PATH. @@ -254,7 +254,7 @@ $ nix-shell -p sqlite 'git.override { withManual = false; }' The -p flag looks up Nixpkgs in the Nix search path. You can override it by passing or setting -NIX_PATH. For example, the following gives you a shell +NIX_PATH. For example, the following gives you a shell containing the Pan package from a specific revision of Nixpkgs: diff --git a/doc/manual/command-ref/nix-store.xml b/doc/manual/command-ref/nix-store.xml index d71f9d8e4..459100984 100644 --- a/doc/manual/command-ref/nix-store.xml +++ b/doc/manual/command-ref/nix-store.xml @@ -1433,7 +1433,7 @@ loads it into the Nix database. The operation prints out the environment of a derivation in a format that can be evaluated by a shell. The command line arguments of the builder are placed in the -variable _args. +variable _args. diff --git a/doc/manual/command-ref/opt-common.xml b/doc/manual/command-ref/opt-common.xml index a68eef1d0..150e732ff 100644 --- a/doc/manual/command-ref/opt-common.xml +++ b/doc/manual/command-ref/opt-common.xml @@ -160,7 +160,7 @@ - Sets the value of the NIX_BUILD_CORES + Sets the value of the NIX_BUILD_CORES environment variable in the invocation of builders. Builders can use this variable at their discretion to control the maximum amount of parallelism. For instance, in Nixpkgs, if the derivation @@ -370,10 +370,10 @@ Add a path to the Nix expression search path. This option may be given multiple times. See the NIX_PATH environment variable for + linkend="env-NIX_PATH">NIX_PATH environment variable for information on the semantics of the Nix search path. Paths added through take precedence over - NIX_PATH. + NIX_PATH. diff --git a/doc/manual/expressions/advanced-attributes.xml b/doc/manual/expressions/advanced-attributes.xml index 5759ff50e..3a0413ceb 100644 --- a/doc/manual/expressions/advanced-attributes.xml +++ b/doc/manual/expressions/advanced-attributes.xml @@ -139,7 +139,7 @@ impureEnvVars = [ "http_proxy" "https_proxy" ... ]; to make it use the proxy server configuration specified by the - user in the environment variables http_proxy and + user in the environment variables http_proxy and friends. This attribute is only allowed in then when the builder runs, the environment variable - bigPath will contain the absolute path to a + bigPath will contain the absolute path to a temporary file containing a very long string. That is, for any attribute x listed in passAsFile, Nix will pass an environment - variable xPath holding + variable xPath holding the path of the file containing the value of attribute x. This is useful when you need to pass large strings to a builder, since most operating systems impose a diff --git a/doc/manual/expressions/build-script.xml b/doc/manual/expressions/build-script.xml index 7bad8f808..44264239d 100644 --- a/doc/manual/expressions/build-script.xml +++ b/doc/manual/expressions/build-script.xml @@ -35,19 +35,19 @@ steps: When Nix runs a builder, it initially completely clears the environment (except for the attributes declared in the - derivation). For instance, the PATH variable is + derivation). For instance, the PATH variable is emptyActually, it's initialised to /path-not-set to prevent Bash from setting it to a default value.. This is done to prevent undeclared inputs from being used in the build process. If for - example the PATH contained + example the PATH contained /usr/bin, then you might accidentally use /usr/bin/gcc. So the first step is to set up the environment. This is done by calling the setup script of the standard environment. The environment variable - stdenv points to the location of the standard + stdenv points to the location of the standard environment being used. (It wasn't specified explicitly as an attribute in , but mkDerivation adds it automatically.) @@ -57,7 +57,7 @@ steps: Since Hello needs Perl, we have to make sure that Perl is in - the PATH. The perl environment + the PATH. The perl environment variable points to the location of the Perl package (since it was passed in as an attribute to the derivation), so $perl/bin is the @@ -70,7 +70,7 @@ steps: Now we have to unpack the sources. The src attribute was bound to the result of fetching the Hello source tarball from the network, so the - src environment variable points to the location in + src environment variable points to the location in the Nix store to which the tarball was downloaded. After unpacking, we cd to the resulting source directory. @@ -93,7 +93,7 @@ steps: /nix/store/9a54ba97fb71b65fda531012d0443ce2-hello-2.1.1. Nix computes this path by cryptographically hashing all attributes of the derivation. The path is passed to the builder through the - out environment variable. So here we give + out environment variable. So here we give configure the parameter --prefix=$out to cause Hello to be installed in the expected location. @@ -103,7 +103,7 @@ steps: Finally we build Hello (make) and install - it into the location specified by out + it into the location specified by out (make install). diff --git a/doc/manual/expressions/derivations.xml b/doc/manual/expressions/derivations.xml index 6f6297565..a11de0088 100644 --- a/doc/manual/expressions/derivations.xml +++ b/doc/manual/expressions/derivations.xml @@ -122,7 +122,7 @@ the Nixpkgs manual for details. A temporary directory is created under the directory - specified by TMPDIR (default + specified by TMPDIR (default /tmp) where the build will take place. The current directory is changed to this directory. @@ -133,29 +133,29 @@ the Nixpkgs manual for details. - NIX_BUILD_TOP contains the path of + NIX_BUILD_TOP contains the path of the temporary directory for this build. - Also, TMPDIR, - TEMPDIR, TMP, TEMP + Also, TMPDIR, + TEMPDIR, TMP, TEMP are set to point to the temporary directory. This is to prevent the builder from accidentally writing temporary files anywhere else. Doing so might cause interference by other processes. - PATH is set to + PATH is set to /path-not-set to prevent shells from initialising it to their built-in default value. - HOME is set to + HOME is set to /homeless-shelter to prevent programs from using /etc/passwd or the like to find the user's home directory, which could cause impurity. Usually, when - HOME is set, it is used as the location of the home + HOME is set, it is used as the location of the home directory, even if it points to a non-existent path. - NIX_STORE is set to the path of the + NIX_STORE is set to the path of the top-level Nix store directory (typically, /nix/store). diff --git a/doc/manual/expressions/generic-builder.xml b/doc/manual/expressions/generic-builder.xml index db7ff405d..16b0268a7 100644 --- a/doc/manual/expressions/generic-builder.xml +++ b/doc/manual/expressions/generic-builder.xml @@ -38,18 +38,18 @@ genericBuild - The buildInputs variable tells + The buildInputs variable tells setup to use the indicated packages as inputs. This means that if a package provides a bin subdirectory, it's added to - PATH; if it has a include + PATH; if it has a include subdirectory, it's added to GCC's header search path; and so on.How does it work? setup tries to source the file pkg/nix-support/setup-hook of all dependencies. These “setup hooks” can then set up whatever environment variables they want; for instance, the setup hook for - Perl sets the PERL5LIB environment variable to + Perl sets the PERL5LIB environment variable to contain the lib/site_perl directories of all inputs. @@ -78,7 +78,7 @@ genericBuild Discerning readers will note that the -buildInputs could just as well have been set in the Nix +buildInputs could just as well have been set in the Nix expression, like this: diff --git a/doc/manual/expressions/language-values.xml b/doc/manual/expressions/language-values.xml index bb2090c88..4a72c67a8 100644 --- a/doc/manual/expressions/language-values.xml +++ b/doc/manual/expressions/language-values.xml @@ -176,7 +176,7 @@ stdenv.mkDerivation { Paths can also be specified between angle brackets, e.g. <nixpkgs>. This means that the directories listed in the environment variable - NIX_PATH will be searched + NIX_PATH will be searched for the given file or directory name. diff --git a/doc/manual/expressions/simple-building-testing.xml b/doc/manual/expressions/simple-building-testing.xml index ce0a1636d..33a802e83 100644 --- a/doc/manual/expressions/simple-building-testing.xml +++ b/doc/manual/expressions/simple-building-testing.xml @@ -45,7 +45,7 @@ name. Nix has transactional semantics. Once a build finishes successfully, Nix makes a note of this in its database: it registers -that the path denoted by out is now +that the path denoted by out is now valid. If you try to build the derivation again, Nix will see that the path is already valid and finish immediately. If a build fails, either because it returns a non-zero exit code, because diff --git a/doc/manual/installation/env-variables.xml b/doc/manual/installation/env-variables.xml index cc52f5b4a..436f15f31 100644 --- a/doc/manual/installation/env-variables.xml +++ b/doc/manual/installation/env-variables.xml @@ -7,7 +7,7 @@ Environment Variables To use Nix, some environment variables should be set. In -particular, PATH should contain the directories +particular, PATH should contain the directories prefix/bin and ~/.nix-profile/bin. The first directory contains the Nix tools themselves, while ~/.nix-profile is @@ -23,15 +23,15 @@ source prefix/etc/profile.d/nix.sh
-<envar>NIX_SSL_CERT_FILE</envar> +<literal>NIX_SSL_CERT_FILE</literal> If you need to specify a custom certificate bundle to account for an HTTPS-intercepting man in the middle proxy, you must specify the path to the certificate bundle in the environment variable -NIX_SSL_CERT_FILE. +NIX_SSL_CERT_FILE. -If you don't specify a NIX_SSL_CERT_FILE +If you don't specify a NIX_SSL_CERT_FILE manually, Nix will install and use its own certificate bundle. @@ -56,7 +56,7 @@ the Nix installer will detect the presense of Nix configuration, and abort.
-<envar>NIX_SSL_CERT_FILE</envar> with macOS and the Nix daemon +<literal>NIX_SSL_CERT_FILE</literal> with macOS and the Nix daemon On macOS you must specify the environment variable for the Nix daemon service, then restart it: diff --git a/doc/manual/installation/installing-binary.xml b/doc/manual/installation/installing-binary.xml index 64c7a37fb..ad47ce8b9 100644 --- a/doc/manual/installation/installing-binary.xml +++ b/doc/manual/installation/installing-binary.xml @@ -61,7 +61,7 @@ The install script will modify the first writable file from amongst .bash_profile, .bash_login and .profile to source ~/.nix-profile/etc/profile.d/nix.sh. You can set -the NIX_INSTALLER_NO_MODIFY_PROFILE environment +the NIX_INSTALLER_NO_MODIFY_PROFILE environment variable before executing the install script to disable this behaviour. diff --git a/doc/manual/installation/multi-user.xml b/doc/manual/installation/multi-user.xml index 69ae1ef27..331b5f128 100644 --- a/doc/manual/installation/multi-user.xml +++ b/doc/manual/installation/multi-user.xml @@ -69,7 +69,7 @@ You’ll want to put that line somewhere in your system’s boot scripts. To let unprivileged users use the daemon, they should set the -NIX_REMOTE environment +NIX_REMOTE environment variable to daemon. So you should put a line like diff --git a/doc/manual/introduction/about-nix.xml b/doc/manual/introduction/about-nix.xml index c21ed34dd..ec6f1ca3f 100644 --- a/doc/manual/introduction/about-nix.xml +++ b/doc/manual/introduction/about-nix.xml @@ -76,7 +76,7 @@ extremely well. Nix has multi-user support. This means that non-privileged users can securely install software. Each user can have a different profile, a set of packages in the Nix store that -appear in the user’s PATH. If a user installs a +appear in the user’s PATH. If a user installs a package that another user has already installed previously, the package won’t be built or downloaded a second time. At the same time, it is not possible for one user to inject a Trojan horse into a diff --git a/doc/manual/packages/basic-package-mgmt.xml b/doc/manual/packages/basic-package-mgmt.xml index 0f21297f3..758a4500d 100644 --- a/doc/manual/packages/basic-package-mgmt.xml +++ b/doc/manual/packages/basic-package-mgmt.xml @@ -16,7 +16,7 @@ on the set of installed applications. That is, there might be lots of applications present on the system (possibly in many different versions), but users can have a specific selection of those active — where “active” just means that it appears in a directory -in the user’s PATH. Such a view on the set of +in the user’s PATH. Such a view on the set of installed applications is called a user environment, which is just a directory tree consisting of symlinks to the files of the active applications. diff --git a/doc/manual/packages/profiles.xml b/doc/manual/packages/profiles.xml index 4d10319ab..15085ab58 100644 --- a/doc/manual/packages/profiles.xml +++ b/doc/manual/packages/profiles.xml @@ -41,9 +41,9 @@ store. $ /nix/store/dpmvp969yhdq...-subversion-1.1.3/bin/svn every time you want to run Subversion. Of course we could set up the -PATH environment variable to include the +PATH environment variable to include the bin directory of every package we want to use, -but this is not very convenient since changing PATH +but this is not very convenient since changing PATH doesn’t take effect for already existing processes. The solution Nix uses is to create directory trees of symlinks to activated packages. These are called @@ -122,10 +122,10 @@ $ nix-env --list-generations You generally wouldn’t have /nix/var/nix/profiles/some-profile/bin -in your PATH. Rather, there is a symlink +in your PATH. Rather, there is a symlink ~/.nix-profile that points to your current profile. This means that you should put -~/.nix-profile/bin in your PATH +~/.nix-profile/bin in your PATH (and indeed, that’s what the initialisation script /nix/etc/profile.d/nix.sh does). This makes it easier to switch to a different profile. You can do that using the diff --git a/doc/manual/release-notes/rl-0.10.xml b/doc/manual/release-notes/rl-0.10.xml index 9afec4de9..9b4233546 100644 --- a/doc/manual/release-notes/rl-0.10.xml +++ b/doc/manual/release-notes/rl-0.10.xml @@ -184,9 +184,9 @@ irreversible. Nix now works behind an HTTP proxy server; just set - the standard environment variables http_proxy, - https_proxy, ftp_proxy or - all_proxy appropriately. Functions such as + the standard environment variables http_proxy, + https_proxy, ftp_proxy or + all_proxy appropriately. Functions such as fetchurl in Nixpkgs also respect these variables. diff --git a/doc/manual/release-notes/rl-0.12.xml b/doc/manual/release-notes/rl-0.12.xml index fdba8c4d5..18978ac4b 100644 --- a/doc/manual/release-notes/rl-0.12.xml +++ b/doc/manual/release-notes/rl-0.12.xml @@ -49,7 +49,7 @@ $ rm __db* log.* derivers references referrers reserved validpaths DB_CONFIGsshfs. The environment - variable NIX_OTHER_STORES specifies the locations of + variable NIX_OTHER_STORES specifies the locations of the remote Nix directories, e.g. /mnt/remote-fs/nix. @@ -156,7 +156,7 @@ the following paths will be downloaded/copied (30.02 MiB): nix-prefetch-url now supports mirror:// URLs, provided that the environment - variable NIXPKGS_ALL points at a Nixpkgs + variable NIXPKGS_ALL points at a Nixpkgs tree. Removed the commands diff --git a/doc/manual/release-notes/rl-0.16.xml b/doc/manual/release-notes/rl-0.16.xml index af1edc0eb..43b7622c6 100644 --- a/doc/manual/release-notes/rl-0.16.xml +++ b/doc/manual/release-notes/rl-0.16.xml @@ -30,7 +30,7 @@ N as well as a configuration setting build-cores = N that causes the - environment variable NIX_BUILD_CORES to be set to + environment variable NIX_BUILD_CORES to be set to N when the builder is invoked. The builder can use this at its discretion to perform a parallel build, e.g., by calling make -j diff --git a/doc/manual/release-notes/rl-1.0.xml b/doc/manual/release-notes/rl-1.0.xml index ff11168d0..41081a19f 100644 --- a/doc/manual/release-notes/rl-1.0.xml +++ b/doc/manual/release-notes/rl-1.0.xml @@ -29,7 +29,7 @@ previous release. Here are the most significant: Nix now has an search path for expressions. The search path - is set using the environment variable NIX_PATH and + is set using the environment variable NIX_PATH and the command line option. In Nix expressions, paths between angle brackets are used to specify files that must be looked up in the search path. For instance, the expression diff --git a/doc/manual/release-notes/rl-1.2.xml b/doc/manual/release-notes/rl-1.2.xml index 748fd9e67..29bd5bf81 100644 --- a/doc/manual/release-notes/rl-1.2.xml +++ b/doc/manual/release-notes/rl-1.2.xml @@ -116,7 +116,7 @@ $ mount -o remount,ro,bind /nix/store Basic Nix expression evaluation profiling: setting the - environment variable NIX_COUNT_CALLS to + environment variable NIX_COUNT_CALLS to 1 will cause Nix to print how many times each primop or function was executed. diff --git a/doc/manual/release-notes/rl-1.6.xml b/doc/manual/release-notes/rl-1.6.xml index 580563420..cdb52ed0b 100644 --- a/doc/manual/release-notes/rl-1.6.xml +++ b/doc/manual/release-notes/rl-1.6.xml @@ -33,7 +33,7 @@ features: nix-shell now sets the shell prompt - (PS1) to ensure that Nix shells are distinguishable + (PS1) to ensure that Nix shells are distinguishable from your regular shells. diff --git a/doc/manual/release-notes/rl-1.8.xml b/doc/manual/release-notes/rl-1.8.xml index c854c5c5f..326990774 100644 --- a/doc/manual/release-notes/rl-1.8.xml +++ b/doc/manual/release-notes/rl-1.8.xml @@ -105,7 +105,7 @@ $ nix-store -l $(which xterm) some terminals show them anyway. Various commands now automatically pipe their output - into the pager as specified by the PAGER environment + into the pager as specified by the PAGER environment variable. Several improvements to reduce memory consumption in diff --git a/doc/manual/release-notes/rl-1.9.xml b/doc/manual/release-notes/rl-1.9.xml index c8406bd20..cc6558b1a 100644 --- a/doc/manual/release-notes/rl-1.9.xml +++ b/doc/manual/release-notes/rl-1.9.xml @@ -62,7 +62,7 @@ $ nix-build https://github.com/NixOS/nixpkgs/archive/master.tar.gz -A hello master branch. In the Nix search path (as specified via - NIX_PATH or ). For example, to + NIX_PATH or ). For example, to start a shell containing the Pan package from a specific version of Nixpkgs: @@ -190,8 +190,8 @@ main = do “generation” symlink in /nix/var/nix/profiles if something actually changed. - The environment variable NIX_PAGER - can now be set to override PAGER. You can set it to + The environment variable NIX_PAGER + can now be set to override PAGER. You can set it to cat to disable paging for Nix commands only. diff --git a/doc/manual/release-notes/rl-2.0.xml b/doc/manual/release-notes/rl-2.0.xml index 4c683dd3d..57acfd0ba 100644 --- a/doc/manual/release-notes/rl-2.0.xml +++ b/doc/manual/release-notes/rl-2.0.xml @@ -30,7 +30,7 @@ The “copy from other stores” substituter mechanism (copy-from-other-stores and the - NIX_OTHER_STORES environment variable) has been + NIX_OTHER_STORES environment variable) has been removed. It was primarily used by the NixOS installer to copy available paths from the installation medium. The replacement is to use a chroot store as a substituter @@ -371,7 +371,7 @@ daemon. You can use auto or the empty string to auto-select a local or daemon store depending on whether you have write permission to the Nix store. It is no - longer necessary to set the NIX_REMOTE + longer necessary to set the NIX_REMOTE environment variable to use the Nix daemon. As noted above, LocalStore now @@ -492,7 +492,7 @@ use /build instead of /tmp as the temporary build directory. This fixes potential security problems when a build - accidentally stores its TMPDIR in some + accidentally stores its TMPDIR in some security-sensitive place, such as an RPATH. @@ -546,8 +546,8 @@ are not using the Nix daemon, you can now just specify a remote build machine on the command line, e.g. --option builders 'ssh://my-mac x86_64-darwin'. The environment variable - NIX_BUILD_HOOK has been removed and is no longer - needed. The environment variable NIX_REMOTE_SYSTEMS + NIX_BUILD_HOOK has been removed and is no longer + needed. The environment variable NIX_REMOTE_SYSTEMS is still supported for compatibility, but it is also possible to specify builders in nix.conf by setting the option builders = @@ -574,7 +574,7 @@ - NIX_PATH is now lazy, so URIs in the path are + NIX_PATH is now lazy, so URIs in the path are only downloaded if they are needed for evaluation. @@ -672,7 +672,7 @@ nix-shell now uses bashInteractive from Nixpkgs, rather than the bash command that happens to be in the caller’s - PATH. This is especially important on macOS where + PATH. This is especially important on macOS where the bash provided by the system is seriously outdated and cannot execute stdenv’s setup script. @@ -720,7 +720,7 @@ configureFlags = "--prefix=${placeholder "out"} --includedir=${placeholder "dev"}"; - will cause the configureFlags environment variable + will cause the configureFlags environment variable to contain the actual store paths corresponding to the out and dev outputs. @@ -815,7 +815,7 @@ configureFlags = "--prefix=${placeholder "out"} --includedir=${placeholder "dev" __structuredAttrs is set to true, the other derivation attributes are serialised in JSON format and made available to the builder via - the file .attrs.json in the builder’s temporary + the file .attrs.json in the builder’s temporary directory. This obviates the need for passAsFile since JSON files have no size restrictions, unlike process environments. @@ -823,7 +823,7 @@ configureFlags = "--prefix=${placeholder "out"} --includedir=${placeholder "dev" As a convenience to Bash builders, Nix writes a script named - .attrs.sh to the builder’s directory that + .attrs.sh to the builder’s directory that initialises shell variables corresponding to all attributes that are representable in Bash. This includes non-nested (associative) arrays. For example, the attribute hardening.format = @@ -835,7 +835,7 @@ configureFlags = "--prefix=${placeholder "out"} --includedir=${placeholder "dev" Builders can now communicate what build phase they are in by writing messages to - the file descriptor specified in NIX_LOG_FD. The + the file descriptor specified in NIX_LOG_FD. The current phase is shown by the nix progress indicator. diff --git a/doc/manual/release-notes/rl-2.2.xml b/doc/manual/release-notes/rl-2.2.xml index d29eb87e8..cc992fabb 100644 --- a/doc/manual/release-notes/rl-2.2.xml +++ b/doc/manual/release-notes/rl-2.2.xml @@ -114,8 +114,8 @@ import <nix/fetchurl.nix> { The evaluator now prints profiling statistics (enabled via - the NIX_SHOW_STATS and - NIX_COUNT_CALLS environment variables) in JSON + the NIX_SHOW_STATS and + NIX_COUNT_CALLS environment variables) in JSON format. diff --git a/doc/manual/release-notes/rl-2.3.xml b/doc/manual/release-notes/rl-2.3.xml index 0ad7d641f..83accf33e 100644 --- a/doc/manual/release-notes/rl-2.3.xml +++ b/doc/manual/release-notes/rl-2.3.xml @@ -60,7 +60,7 @@ incompatible changes: Builds are now executed in a pseudo-terminal, and the - TERM environment variable is set to + TERM environment variable is set to xterm-256color. This allows many programs (e.g. gcc, clang, cmake) to print colorized log output.