lix-project/lix
20
57
Fork 31
Code Issues 349 Code Review (Gerrit) Projects 3 Releases Wiki Activity

Document import <path> syntax

Browse source
This commit is contained in:
Ersin Akinci 2019-10-20 19:08:05 -07:00
parent ab4dd1d783
commit d8730fb86f
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/manual/expressions/builtins.xml
View file

@ -733,13 +733,21 @@ builtins.genList (x: x * x) 5
<varlistentry xml:id='builtin-import'> <varlistentry xml:id='builtin-import'>
<term><function>import</function> <term><function>import</function>
<replaceable>path</replaceable></term> <replaceable>path</replaceable></term>
<term><function>import</function>
<replaceable>&lt;path&gt;</replaceable></term>
<term><function>builtins.import</function> <term><function>builtins.import</function>
<replaceable>path</replaceable></term> <replaceable>path</replaceable></term>
<term><function>builtins.import</function>
<replaceable>&lt;path&gt;</replaceable></term>
<listitem><para>Load, parse and return the Nix expression in the <listitem><para>Load, parse and return the Nix expression in the
file <replaceable>path</replaceable>. If <replaceable>path file <replaceable>path</replaceable>. If <replaceable>path
</replaceable> is a directory, the file <filename>default.nix </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>
&lt;path&gt;</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. file doesn’t exist or contains an incorrect Nix expression.
<function>import</function> implements Nix’s module system: you <function>import</function> implements Nix’s module system: you
can put any Nix expression (such as a set or a function) in a can put any Nix expression (such as a set or a function) in a