From e06f494a81d65177404cf9b1d28a5fbffda0f146 Mon Sep 17 00:00:00 2001
From: Luca Bruno <lethalman88@gmail.com>
Date: Tue, 30 Jun 2015 12:19:49 +0200
Subject: doc: document lib.makeOverridable

---
 doc/functions.xml | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

(limited to 'doc/functions.xml')

diff --git a/doc/functions.xml b/doc/functions.xml
index 89f2fda0ad4b..2aae3cfb2aec 100644
--- a/doc/functions.xml
+++ b/doc/functions.xml
@@ -85,4 +85,36 @@ in ...</programlisting>
 
 </section>
 
+<section xml:id="sec-lib-makeOverridable">
+  <title>lib.makeOverridable</title>
+
+  <para>
+    The function <varname>lib.makeOverridable</varname> is used make the result
+    of a function easily customizable. This utility only makes sense for functions
+    that accept an argument set and return an attribute set.
+  </para>
+
+  <para>
+    Example usage:
+
+    <programlisting>f = { a, b }: { result = a+b; }
+c = lib.makeOverridable f { a = 1; b = 2; }</programlisting>
+
+  </para>
+
+  <para>
+    The variable <varname>c</varname> is the value of the <varname>f</varname> function
+    applied with some default arguments. Hence the value of <varname>c.result</varname>
+    is <literal>3</literal>, in this example.
+  </para>
+
+  <para>
+    The variable <varname>c</varname> however also has some additional functions, like
+    <link linkend="sec-pkg-override">c.override</link> which can be used to
+    override the default arguments. In this example the value of
+    <varname>(c.override { a = 4; }).result</varname> is 6.
+  </para>
+
+</section>
+
 </chapter>
-- 
cgit 1.4.1