about summary refs log tree commit diff
diff options
context:
space:
mode:
authorArnout Engelen <arnout@bzzt.net>2019-11-25T17·00+0100
committerEelco Dolstra <edolstra@gmail.com>2020-01-04T13·12+0100
commit95be8d3b12045b2408656dd852787b0c1053b5ef (patch)
treec81b9ed51ab55936b2b16ea386b910ae00b7cd8e
parent9879e254739d5a36d410ad84bbc9cbf4ef63ac3f (diff)
Document builtins.placeholder
(cherry picked from commit 4e70652ee33641a6cfddbfb9b7d741515f1bf98a)
-rw-r--r--doc/manual/expressions/builtins.xml10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/manual/expressions/builtins.xml b/doc/manual/expressions/builtins.xml
index f39b393bf719..394e1fc32c95 100644
--- 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>