Browse Source

[3259] Corrections to the documentation

Stephen Morris 9 years ago
parent
commit
bc205166c3
2 changed files with 15 additions and 17 deletions
  1. 5 5
      doc/guide/hooks.xml
  2. 10 12
      src/lib/hooks/hooks_user.dox

+ 5 - 5
doc/guide/hooks.xml

@@ -46,9 +46,9 @@
       <command>hooks-libraries</command> keyword in the
       <command>hooks-libraries</command> keyword in the
       configuration for that process. (Note that
       configuration for that process. (Note that
       the word "hooks" is plural).  The value of the keyword
       the word "hooks" is plural).  The value of the keyword
-      is an array of strings, each string corresponding to a hooks library.
-      For example, to set up two hooks libraries for the DHCPv4 server, the
-      configuration would be:
+      is an array of map structures, each structure corresponding to a hooks
+      library.  For example, to set up two hooks libraries for the DHCPv4
+      server, the configuration would be:
 <screen>
 <screen>
 <userinput>"Dhcp4": {
 <userinput>"Dhcp4": {
     :
     :
@@ -74,8 +74,8 @@
       <para>
       <para>
         To ease the transtion, the old syntax is still accepted, although a
         To ease the transtion, the old syntax is still accepted, although a
         warning message is issued when it is encountered.  Users are urged
         warning message is issued when it is encountered.  Users are urged
-        to switch to the new syntax as the old syntax will be withdrawn when
-        parameters are finally added to Kea.
+        to switch to the new syntax as soon as pssible: the old syntax will
+        be withdrawn when parameters are finally added to Kea.
       </para></note>
       </para></note>
       <para>
       <para>
       Notes:
       Notes:

+ 10 - 12
src/lib/hooks/hooks_user.dox

@@ -795,11 +795,9 @@ DHCPv4 module, it must be listed in the "hooks-libraries" element of the
     "hooks-libraries": [
     "hooks-libraries": [
         {
         {
             "library": "/usr/local/lib/example.so"
             "library": "/usr/local/lib/example.so"
-        },
-        {
-            :
         }
         }
-       :
+    ]
+        :
 }
 }
 @endcode
 @endcode
 (Note that "hooks" is plural.)
 (Note that "hooks" is plural.)
@@ -808,18 +806,18 @@ Each entry in the "hooks-libraries" list is a structure (a "map" in JSON
 parlance) that holds the following element:
 parlance) that holds the following element:
 - library - the name of the library to load.  This must be a string.
 - library - the name of the library to load.  This must be a string.
 
 
-The DHCPv4 server will load the library and execute the callouts each time a
-request is received.
-
 @note The syntax of the hooks-libraries configuration element has changed
 @note The syntax of the hooks-libraries configuration element has changed
 since kea 0.9.2 (in that version, "hooks-libraries" was just a list of
 since kea 0.9.2 (in that version, "hooks-libraries" was just a list of
 libraries).  This change is in preparation for the introduction of
 libraries).  This change is in preparation for the introduction of
-library-=specific parameters, which will be added to Kea in a version after 1.0.
+library-specific parameters, which will be added to Kea in a version after 1.0.
+
+The DHCPv4 server will load the library and execute the callouts each time a
+request is received.
 
 
-@note The above assumes that the hooks library will be used with a version of
-Kea that is dynamically-linked.  For information regarding running
-hooks libraries against a statically-linked Kea, see
-@ref hooksdgStaticallyLinkedKea.
+@note All the above assumes that the hooks library will be used with a
+version of Kea that is dynamically-linked.  For information regarding
+running hooks libraries against a statically-linked Kea, see @ref
+hooksdgStaticallyLinkedKea.
 
 
 @section hooksdgAdvancedTopics Advanced Topics
 @section hooksdgAdvancedTopics Advanced Topics