From: Tomek Mrugalski <tomasz@isc.org>
Date: Wed, 31 Oct 2018 17:48:41 +0000 (+0100)
Subject: [#64,!41] Docs updated.
X-Git-Tag: 66-authoritative-flag-in-kea_base~19
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e1b5adfc39b7e065264a1680b6cbf949c4bb5ec9;p=thirdparty%2Fkea.git

[#64,!41] Docs updated.
---

diff --git a/doc/api/class-add.json b/doc/api/class-add.json
index 86fef27765..44afb25c43 100644
--- a/doc/api/class-add.json
+++ b/doc/api/class-add.json
@@ -1,6 +1,7 @@
 {
     "name": "class-add",
-    "brief": "This command is used to create and add a new class to the existing server configuration.",
+    "brief": "This command is used to create and add a new class to the existing
+              server configuration.",
     "description": "See <xref linkend=\"command-class-add\"/>",
     "support": [ "kea-dhcp4", "kea-dhcp6" ],
     "avail": "1.5.0",
@@ -9,15 +10,24 @@
     \"command\": \"class-add\",
     \"arguments\": {
         \"client-classes\": [ {
-           \"name\": \"ipxe_efi_x64\",
-           \"test\": \"option[93].hex == 0x0009\",
-            ...
+           \"name\": <name of the class>,
+           \"test\": <test expression to be evaluated on incoming packets>,
+           \"option-data\": [ <option values here> ],
+           \"option-def\": [ <option defintions here> ],
+           \"next-server\": <ipv4 address>,
+           \"server-hostname\": <string>,
+           \"boot-file-name\": <name of the boot file>
         } ]
     }
 }",
-    "cmd-comment": "Only one client class can be added with a single command.",
+    "cmd-comment": "The <command>next-server</command>,
+                    <command>server-hostname</command> and
+                    <command>boot-file-name</command> are DHCPv4 specific. Only
+                    one client class can be added with a single command. ",
     "resp-syntax": "{
     \"result\": 0,
-    \"text\": \"Class 'ipxe_efi_x64' added.\"
-}"
+    \"text\": \"Class '<class-name>' added.\",
+}",
+    "resp-comment": "The command will be successful (result 0), unless the
+                     class name is a duplicate (result 1)."
 }
diff --git a/doc/guide/api.xml b/doc/guide/api.xml
index d0e49f580c..a693e8ad52 100644
--- a/doc/guide/api.xml
+++ b/doc/guide/api.xml
@@ -548,7 +548,8 @@ Result is an integer representation of the status. Currently supported statuses
 <!-- start of class-add -->
 <section xml:id="reference-class-add">
 <title>class-add reference</title>
-<para xml:id="ref-class-add"><command>class-add</command> - This command is used to create and add a new class to the existing server configuration.</para>
+<para xml:id="ref-class-add"><command>class-add</command> - This command is used to create and add a new class to the existing
+              server configuration.</para>
 
 <para>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command>, <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command></para>
 
@@ -561,27 +562,28 @@ Result is an integer representation of the status. Currently supported statuses
     "command": "class-add",
     "arguments": {
         "client-classes": [ {
-           "name": "ipxe_efi_x64",
-           "test": "option[93].hex == 0x0009",
-            ...
+           "name": &lt;name of the class&gt;,
+           "test": &lt;test expression to be evaluated on incoming packets&gt;,
+           "option-data": [ &lt;option values here&gt; ],
+           "option-def": [ &lt;option defintions here&gt; ],
+           "next-server": &lt;ipv4 address&gt;,
+           "server-hostname": &lt;string&gt;,
+           "boot-file-name": &lt;name of the boot file&gt;
         } ]
     }
 }</screen>
-Only one client class can be added with a single command.</para>
+The <command>next-server</command>, 
+                    <command>server-hostname</command> and 
+                    <command>boot-file-name</command> are DHCPv4 specific. Only
+                    one client class can be added with a single command. </para>
 
 <para>Response syntax:
   <screen>{
     "result": 0,
-    "text": "Class 'ipxe_efi_x64' added."
+    "text": "Class '&lt;class-name&gt;' added.",
 }</screen>
-Result is an integer representation of the status. Currently supported statuses are:
-<itemizedlist>
-  <listitem><para>0 - success</para></listitem>
-  <listitem><para>1 - error</para></listitem>
-  <listitem><para>2 - unsupported</para></listitem>
-  <listitem><para>3 - empty (command was completed successfully, but no data was affected or returned)</para></listitem>
-</itemizedlist>
-</para>
+The command will be successful (result 0), unless the
+                     class name is a duplicate (result 1).</para>
 
 </section>
 <!-- end of class-add -->
diff --git a/doc/guide/hooks-class-cmds.xml b/doc/guide/hooks-class-cmds.xml
index 2792eb6aab..0c45236d44 100644
--- a/doc/guide/hooks-class-cmds.xml
+++ b/doc/guide/hooks-class-cmds.xml
@@ -22,7 +22,7 @@
         </note>
 
         <para>The Class Commands hooks library is available to premium Kea
-        customers only</para>
+        customers only.</para>
       </para>
 
       <section xml:id="command-class-add">