lix-project/lix
19
52
Fork 27
Code Issues 341 Code Review (Gerrit) Projects 2 Releases Wiki Activity

-I description: Use -I examples

Browse source
This commit is contained in:
Eelco Dolstra 2022-12-12 12:51:23 +01:00
parent add417ec14
commit e558e089ba
1 changed files with 22 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
src/libcmd/common-eval-args.cc
View file

@ -36,21 +36,29 @@ MixEvalArgs::MixEvalArgs()
Add *path* to the Nix search path. The Nix search path is Add *path* to the Nix search path. The Nix search path is
initialized from the colon-separated [`NIX_PATH`](./env-common.md#env-NIX_PATH) environment initialized from the colon-separated [`NIX_PATH`](./env-common.md#env-NIX_PATH) environment
variable, and is used to look up the location of Nix expressions using [paths](../language/values.md#type-path) enclosed in angle variable, and is used to look up the location of Nix expressions using [paths](../language/values.md#type-path) enclosed in angle
brackets (i.e., `<nixpkgs>`). For instance, if the Nix search path brackets (i.e., `<nixpkgs>`).
consists of the entries
For instance, passing
``` ```
/home/eelco/Dev -I /home/eelco/Dev
/etc/nixos -I /etc/nixos
``` ```
Nix will look for paths relative to `/home/eelco/Dev` and will cause Nix to look for paths relative to `/home/eelco/Dev` and
`/etc/nixos`, in this order. It is also possible to match paths `/etc/nixos`, in that order. This is equivalent to setting the
against a prefix. For example, the search path `NIX_PATH` environment variable to
``` ```
nixpkgs=/home/eelco/Dev/nixpkgs-branch /home/eelco/Dev:/etc/nixos
/etc/nixos ```
It is also possible to match paths against a prefix. For example,
passing
```
-I nixpkgs=/home/eelco/Dev/nixpkgs-branch
-I /etc/nixos
``` ```
will cause Nix to search for `<nixpkgs/path>` in will cause Nix to search for `<nixpkgs/path>` in
@ -59,10 +67,10 @@ MixEvalArgs::MixEvalArgs()
If a path in the Nix search path starts with `http://` or `https://`, If a path in the Nix search path starts with `http://` or `https://`,
it is interpreted as the URL of a tarball that will be downloaded and it is interpreted as the URL of a tarball that will be downloaded and
unpacked to a temporary location. The tarball must consist of a single unpacked to a temporary location. The tarball must consist of a single
top-level directory. For example, setting `NIX_PATH` to top-level directory. For example, passing
``` ```
nixpkgs=https://github.com/NixOS/nixpkgs/archive/master.tar.gz -I nixpkgs=https://github.com/NixOS/nixpkgs/archive/master.tar.gz
``` ```
tells Nix to download and use the current contents of the `master` tells Nix to download and use the current contents of the `master`
@ -71,11 +79,11 @@ MixEvalArgs::MixEvalArgs()
The URLs of the tarballs from the official `nixos.org` channels The URLs of the tarballs from the official `nixos.org` channels
(see [the manual page for `nix-channel`](nix-channel.md)) can be (see [the manual page for `nix-channel`](nix-channel.md)) can be
abbreviated as `channel:<channel-name>`. For instance, the abbreviated as `channel:<channel-name>`. For instance, the
following two values of `NIX_PATH` are equivalent: following two flags are equivalent:
``` ```
nixpkgs=channel:nixos-21.05 -I nixpkgs=channel:nixos-21.05
nixpkgs=https://nixos.org/channels/nixos-21.05/nixexprs.tar.xz -I nixpkgs=https://nixos.org/channels/nixos-21.05/nixexprs.tar.xz
``` ```
)", )",
.category = category, .category = category,