Document builtins.placeholder

NixOS · Nov 25, 2019 · 4e70652 · 4e70652
1 parent d12d69e
commit 4e70652
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/doc/manual/expressions/builtins.xml b/doc/manual/expressions/builtins.xml
@@ -1120,6 +1120,16 @@ Evaluates to <literal>[ "foo" ]</literal>.
 
   </varlistentry>
 
+  <varlistentry xml:id='builtin-placeholder'>
+    <term><function>builtins.placeholder</function>
+    <replaceable>output</replaceable></term>
+
+    <listitem><para>Return a placeholder string for the specified
+    <replaceable>output</replaceable> that will be substituted by the
+    corresponding output path at build time. Typical outputs would be
+    <literal>"out"</literal>, <literal>"bin"</literal> or
+    <literal>"dev"</literal>.</para></listitem>
+  </varlistentry>
 
   <varlistentry xml:id='builtin-readDir'>
     <term><function>builtins.readDir</function>