From: Tomek Mrugalski <tomasz@isc.org>
Date: Fri, 19 Aug 2016 17:48:51 +0000 (+0200)
Subject: [4483] User's Guide updated.
X-Git-Tag: trac4631_base~15^2~10
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a2d0d05441183cc87e89abdb8891abd1db28ef95;p=thirdparty%2Fkea.git

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

diff --git a/doc/guide/classify.xml b/doc/guide/classify.xml
index a33f005d43..ed109046f6 100644
--- a/doc/guide/classify.xml
+++ b/doc/guide/classify.xml
@@ -181,7 +181,7 @@
               <entry>Integer literal</entry>
               <entry>123</entry>
               <entry>'123'</entry>
-              <entry>An integer value</entry>
+              <entry>A 32 bits unsigned integer value</entry>
             </row>
             <row></row>
             <row>
@@ -257,7 +257,8 @@
               <entry>Length of packet</entry>
               <entry>pkt.len</entry>
               <entry>0x00000100</entry>
-              <entry>The length of a DHCP packet (UDP header field) padded to 4 bytes.</entry>
+              <entry>The length of a DHCP packet (UDP header field), expressed
+              as 32 bits unsigned integer.</entry>
             </row>
             <row>
               <entry>Hardware address in DHCPv4 packet</entry>
@@ -301,19 +302,33 @@
               <entry>192.0.2.1</entry>
               <entry>The value of the siaddr field of the DHCPv4 packet (IPv4 address, 4 bytes)</entry>
             </row>
+            <row>
+              <entry>Message Type in DHCPv4 packet</entry>
+              <entry>pkt4.msgtype</entry>
+              <entry>1</entry>
+              <entry>The value of the message type field in the DHCPv4
+              packet (expressed as 32 bits unsigned integer).</entry>
+            </row>
+            <row>
+              <entry>Transaction ID (xid) in DHCPv4 packet</entry>
+              <entry>pkt4.transid</entry>
+              <entry>12345</entry>
+              <entry>The value of the transaction id in the DHCPv4
+              packet (expressed as 32 bits unsigned integer).</entry>
+            </row>
             <row>
               <entry>Message Type in DHCPv6 packet</entry>
               <entry>pkt6.msgtype</entry>
               <entry>1</entry>
               <entry>The value of the message type field in the DHCPv6
-              packet.</entry>
+              packet (expressed as 32 bits unsigned integer).</entry>
             </row>
             <row>
               <entry>Transaction ID in DHCPv6 packet</entry>
               <entry>pkt6.transid</entry>
               <entry>12345</entry>
               <entry>The value of the transaction id in the DHCPv6
-              packet.</entry>
+              packet (expressed as 32 bits unsigned integer).</entry>
             </row>
 
             <row>
@@ -411,8 +426,14 @@
       </para>
 
       <para>
-      Integers in the expression are converted to strings
-      when the expression is read into Kea.
+      Integers in the expression are converted to 32 bit unsigned integers and
+      are represented as four byte strings. For example 123 is represented as
+      0x0000007b. All expressions that return numeric values use 32 bits
+      unsigned integers, even if the field in the packet is smaller.  In general
+      it is easier to use decimal notation to represent integers, but it is also
+      possible to use hex notation. When using hex notation to represent an
+      integer care should be taken to make sure the value is represented as 32
+      bits, e.g. use 0x00000001 instead of 0x1 or 0x01.
       </para>
 
       <para>