diff options
| author | Ersin Akinci <me@ersinakinci.com> | 2019-10-20 19:08:05 -0700 |
|---|---|---|
| committer | Ersin Akinci <me@ersinakinci.com> | 2019-10-20 19:08:05 -0700 |
| commit | d8730fb86facadbef22d3df7f8a743a56e7ed53c (patch) | |
| tree | 1e36661d307ba54f96f7977cb0fe6a98a1b904e1 /doc | |
| parent | ab4dd1d78306c58cb9ee1fa5009ef18b67e26314 (diff) | |
Document import <path> syntax
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/expressions/builtins.xml | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/manual/expressions/builtins.xml b/doc/manual/expressions/builtins.xml index 465fa1e0b..21da8b87b 100644 --- a/doc/manual/expressions/builtins.xml +++ b/doc/manual/expressions/builtins.xml @@ -733,13 +733,21 @@ builtins.genList (x: x * x) 5 <varlistentry xml:id='builtin-import'> <term><function>import</function> <replaceable>path</replaceable></term> + <term><function>import</function> + <replaceable><path></replaceable></term> <term><function>builtins.import</function> <replaceable>path</replaceable></term> + <term><function>builtins.import</function> + <replaceable><path></replaceable></term> <listitem><para>Load, parse and return the Nix expression in the file <replaceable>path</replaceable>. If <replaceable>path </replaceable> is a directory, the file <filename>default.nix - </filename> in that directory is loaded. Evaluation aborts if the + </filename> in that directory is loaded. If the <replaceable> + <path></replaceable> syntax is used, the path will be resolved + relative to those listed in the <envar>NIX_PATH</envar> environment + variable (see the section on <envar linkend="env-NIX_PATH">NIX_PATH</envar> + for details on how the resolution works). Evaluation aborts if the file doesn’t exist or contains an incorrect Nix expression. <function>import</function> implements Nix’s module system: you can put any Nix expression (such as a set or a function) in a |