From: Tomek Mrugalski <tomasz@isc.org>
Date: Tue, 15 Mar 2016 09:48:03 +0000 (+0100)
Subject: [4297] User's Guide updated.
X-Git-Tag: trac4298_base~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e6f3b958ec1448e71d30a1c78c0ffbc3452e00ee;p=thirdparty%2Fkea.git

[4297] User's Guide updated.
---

diff --git a/doc/guide/hooks.xml b/doc/guide/hooks.xml
index 6c275fdc20..6418e3b4b1 100644
--- a/doc/guide/hooks.xml
+++ b/doc/guide/hooks.xml
@@ -57,7 +57,17 @@
             "library": "/opt/charging.so"
         },
         {
-            "library": "/opt/local/notification.so"
+            "library": "/opt/local/notification.so",
+            "parameters": {
+                "mail": "spam@example.com",
+                "floor": 13,
+                "debug": false,
+                "users": [ "alice", "bob", "charlie" ],
+                "languages": {
+                    "french": "bonjour",
+                    "klingon": "yl'el"
+                }
+            }
         }
     ]
     :
@@ -71,6 +81,32 @@
         specification of library-specific parameters, a feature that will be
         added to a future version of Kea.
       </para></note>
+
+      <note>
+        <para>
+          The library reloading behavior has changed in Kea 1.1. Libraries are
+          reloaded, even if their list hasn't changed. Kea does that, because
+          the parameters specified for the library (or the files those
+          parameters point to) may have changed.
+        </para>
+      </note>
+
+      <para>
+        Libraries may have additional parameters. Those are not mandatory in the
+        sense that there may be libraries that don't require them. However, for
+        specific library there is often specific requirement for specify certain
+        set of parameters. Please consult the documentation for your library
+        for details. In the example above, the first library has no parameters.
+        The second library has five parameters, specifying mail (string
+        parameter), floor (integer parameter), debug (boolean parameter) and
+        even lists (list of strings) and maps (containing strings). Nested
+        parameters could be used if the library supports it. This topic is
+        explained in detail in the Hooks Developer's Guide in Configuring Hooks
+        Libraries section.
+      </para>
+
+      </para>
+
       <para>
       Notes:
         <itemizedlist mark='bullet'>