Browse Source

[3927] Tentative to fix option-def descriptions

Francis Dupont 9 years ago
parent
commit
f5c8bd14f4
2 changed files with 17 additions and 8 deletions
  1. 8 8
      doc/guide/dhcp4-srv.xml
  2. 9 0
      doc/guide/dhcp6-srv.xml

+ 8 - 8
doc/guide/dhcp4-srv.xml

@@ -1160,14 +1160,14 @@ It is merely echoed by the server
       should be left blank.  Note that the above set of comments define the
       should be left blank.  Note that the above set of comments define the
       format of the new option and do not set its values.
       format of the new option and do not set its values.
       </para>
       </para>
-      <note>
-        <para>
-          In the current release the default values are not propagated to the
-          parser when the new configuration is being set. Therefore, all
-          parameters must be specified at all times, even if their values are
-          left blank.
-        </para>
-      </note>
+
+      <para>The <command>name</command>, <command>code</command> and
+      <command>type</command> parameters are required, all others are
+      optional. The <command>array</command> default value is
+      <command>false</command>. The <command>record-types</command>
+      and <command>encapsulate</command> default values are blank
+      (i.e. ""). The default <command>space</command> is "dhcp4".
+      </para>
 
 
       <para>Once the new option format is defined, its value is set
       <para>Once the new option format is defined, its value is set
       in the same way as for a standard option. For example the following
       in the same way as for a standard option. For example the following

+ 9 - 0
doc/guide/dhcp6-srv.xml

@@ -1022,6 +1022,15 @@ temporarily override a list of interface names and listen on all interfaces.
       set of comments define the format of the new option and do not set its
       set of comments define the format of the new option and do not set its
       values.
       values.
       </para>
       </para>
+
+      <para>The <command>name</command>, <command>code</command> and
+      <command>type</command> parameters are required, all others are
+      optional. The <command>array</command> default value is
+      <command>false</command>. The <command>record-types</command>
+      and <command>encapsulate</command> default values are blank
+      (i.e. ""). The default <command>space</command> is "dhcp4".
+      </para>
+
       <para>Once the new option format is defined, its value is set
       <para>Once the new option format is defined, its value is set
       in the same way as for a standard option. For example the following
       in the same way as for a standard option. For example the following
       commands set a global value that applies to all subnets.
       commands set a global value that applies to all subnets.