[trac4218] Remove descritpion of .text from classification

The use of .text isn't really clear yet and rather than confuse
users we are removing it from the documentation.

diff --git a/ChangeLog b/ChangeLog
index 4f485439483c25c1a0159a108a351b0f3c35b7ad..95479ca0fd429198e097ff866c823db5bacd751b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+106x.  [doc]           sar
+       Remove description of option[xx].text operator from classification
+       until it's use becomes clearer.
+       (Trac #4218, git TBD)
+
 1065.  [func]          tomek
        Configuration parameters for setting up external hosts storage
        are now implemented. This feature is considered experimental

diff --git a/doc/guide/classify.xml b/doc/guide/classify.xml
index 02317cb95a2bbc91c395683571b61af9f5c49ff1..2fd21bb206d116a519da64385c2f03bcbe31b321 100644 (file)
--- a/doc/guide/classify.xml
+++ b/doc/guide/classify.xml
@@ -160,7 +160,9 @@
 <row><entry>String</entry><entry>'example'</entry><entry>A string</entry></row>
 <row><entry>Hex String</entry><entry>0XABCD</entry><entry>A hexadecimal string</entry></row>
 <row><entry>Integer</entry><entry>123</entry><entry>An integer value</entry></row>
+<!-- Text option not fully defined yet, leave it out
 <row><entry>Option Text</entry><entry>option[code].text</entry><entry>The value of the option with code "code" from the packet as text</entry></row>
+-->
 <row><entry>Option Hex</entry><entry>option[code].hex</entry><entry>The value of the option with code "code" from the packet as hex</entry></row>
           </tbody>
           </tgroup>
@@ -176,11 +178,10 @@
       </para>
 
       <para>
-      "option[code]" extracts the value of the option with the given code
+      "option[code].hex" extracts the value of the option with the given code
       from the incoming packet. If the packet doesn't contain the option, it
-      returns the empty string.  The string can be presented as text or hex
-      with the ".text" or ".hex" modifiers.  In both cases only the payload
-      is presented; the type code and length fields are not included.
+      returns the empty string. The string is presented as a byte string of
+      the option payload without the type code or length fields.
       </para>
 
       <para>
@@ -269,7 +270,7 @@
     "client-classes": [<userinput>
         {
             "name": "Client_foo",
-            "test": "substring(option[61].text,0,3) == 'foo'",
+            "test": "substring(option[61].hex,0,3) == 'foo'",
             "option-data": [
                 {
                     "name": "domain-name-servers",
@@ -335,7 +336,7 @@
     "client-classes": [
         {
             "name": "Client_foo",
-            "test": "substring(option[61].text,0,3) == 'foo'",
+            "test": "substring(option[61].hex,0,3) == 'foo'",
             "option-data": [
                 {
                     "name": "domain-name-servers",

diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml
index fd6afd9b6c87432dc6380d797cce236ca3c38751..a4be35539db901b1e8ea2810b68bf224257647c4 100644 (file)
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@ -1738,7 +1738,7 @@ It is merely echoed by the server
     "client-classes": [
         {<userinput>
             "name": "Client_foo",
-            "test": "substring(option[61].text,0,3) == 'foo'",
+            "test": "substring(option[61].hex,0,3) == 'foo'",
             "option-data": [
                 {
                     "name": "domain-name-servers",