From: Razvan Becheriu <razvan@isc.org>
Date: Fri, 28 May 2021 08:55:11 +0000 (+0300)
Subject: [#1862] fixed documentation
X-Git-Tag: Kea-1.9.9~155
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=67f90ea9ecd4cba5e84e3871079ec39a810f6590;p=thirdparty%2Fkea.git

[#1862] fixed documentation
---

diff --git a/doc/sphinx/arm/hooks.rst b/doc/sphinx/arm/hooks.rst
index 23e86d89b0..2d88638c66 100644
--- a/doc/sphinx/arm/hooks.rst
+++ b/doc/sphinx/arm/hooks.rst
@@ -967,7 +967,9 @@ Examples:
                 ifelse(option[61].exists,
                     ', client-id: ' + hexstring(option[61].hex, ':'),
                     '') +
-                ifelse(pkt4.giaddr == 0.0.0.0, '', ' connected via relay at address: ' + addrtotext(pkt4.giaddr) +
+                ifelse(pkt4.giaddr == 0.0.0.0,
+                    '',
+                    ' connected via relay at address: ' + addrtotext(pkt4.giaddr) +
                     ifelse(option[82].option[1].exists,
                         ', circuit-id: ' + hexstring(option[82].option[1].hex, ':'),
                         '') +
@@ -975,14 +977,15 @@ Examples:
                         ', remote-id: ' + hexstring(option[82].option[2].hex, ':'),
                         '') +
                     ifelse(option[82].option[6].exists,
-                        ', subscriber-id: ' + hexstring(option[82].option[6].hex,
-                        ':'),
-                    '')),
+                        ', subscriber-id: ' + hexstring(option[82].option[6].hex, ':'),
+                        '')),
                 '')",
         "response-parser-format":
             "ifelse(pkt4.msgtype == 5,
                 'Address: ' + addrtotext(pkt4.yiaddr) + ' has been assigned for ' + uint32totext(option[51].hex) + ' seconds to a device with hardware address: hwtype=' + substring(hexstring(pkt4.htype, ''), 7, 1) + ' ' + hexstring(pkt4.mac, ':') +
-                ifelse(option[61].exists, ', client-id: ' + hexstring(option[61].hex, ':'), '') +
+                ifelse(option[61].exists,
+                    ', client-id: ' + hexstring(option[61].hex, ':'),
+                    '') +
                 ifelse(pkt4.giaddr == 0.0.0.0,
                     '',
                     ' connected via relay at address: ' + addrtotext(pkt4.giaddr) +
@@ -1022,7 +1025,7 @@ Examples:
 .. code-block:: json
 
     {
-        "request-parser-format": "ifelse(pkt4.msgtype == 3, 'Address: ' + ifelse(option[50].exists, addrtotext(option[50].hex), addrtotext(pkt4.ciaddr)) + ' has been assigned ' + ifelse(option[51].exists, 'for ' + uint32totext(option[51].hex) + ' seconds ', '') + to a device with hardware address: hwtype=' + substring(hexstring(pkt4.htype, ''), 7, 1) + ' ' + hexstring(pkt4.mac, ':') + ifelse(option[61].exists, ', client-id: ' + hexstring(option[61].hex, ':'), '') + ifelse(pkt4.giaddr == 0.0.0.0, '', ' connected via relay at address: ' + addrtotext(pkt4.giaddr) + ifelse(option[82].option[1].exists, ', circuit-id: ' + hexstring(option[82].option[1].hex, ':'), '') + ifelse(option[82].option[2].exists, ', remote-id: ' + hexstring(option[82].option[2].hex, ':'), '') + ifelse(option[82].option[6].exists, ', subscriber-id: ' + hexstring(option[82].option[6].hex, ':'), '')), ifelse(pkt4.msgtype == 4 or pkt4.msgtype == 7, 'Address: ' + ifelse(option[50].exists, addrtotext(option[50].hex), addrtotext(pkt4.ciaddr)) + ' has been released from a device with hardware address: hwtype=' + substring(hexstring(pkt4.htype, ''), 7, 1) + ' ' + hexstring(pkt4.mac, ':') + ifelse(option[61].exists, ', client-id: ' + hexstring(option[61].hex, ':'), '') + ifelse(pkt4.giaddr == 0.0.0.0, '', ' connected via relay at address: ' + addrtotext(pkt4.giaddr) + ifelse(option[82].option[1].exists, ', circuit-id: ' + hexstring(option[82].option[1].hex, ':'), '') + ifelse(option[82].option[2].exists, ', remote-id: ' + hexstring(option[82].option[2].hex, ':'), '') + ifelse(option[82].option[6].exists, ', subscriber-id: ' + hexstring(option[82].option[6].hex, ':'), '')), ''))"
+        "request-parser-format": "ifelse(pkt4.msgtype == 3, 'Address: ' + ifelse(option[50].exists, addrtotext(option[50].hex), addrtotext(pkt4.ciaddr)) + ' has been assigned' + ifelse(option[51].exists, ' for ' + uint32totext(option[51].hex) + ' seconds', '') + ' to a device with hardware address: hwtype=' + substring(hexstring(pkt4.htype, ''), 7, 1) + ' ' + hexstring(pkt4.mac, ':') + ifelse(option[61].exists, ', client-id: ' + hexstring(option[61].hex, ':'), '') + ifelse(pkt4.giaddr == 0.0.0.0, '', ' connected via relay at address: ' + addrtotext(pkt4.giaddr) + ifelse(option[82].option[1].exists, ', circuit-id: ' + hexstring(option[82].option[1].hex, ':'), '') + ifelse(option[82].option[2].exists, ', remote-id: ' + hexstring(option[82].option[2].hex, ':'), '') + ifelse(option[82].option[6].exists, ', subscriber-id: ' + hexstring(option[82].option[6].hex, ':'), '')), ifelse(pkt4.msgtype == 4 or pkt4.msgtype == 7, 'Address: ' + ifelse(option[50].exists, addrtotext(option[50].hex), addrtotext(pkt4.ciaddr)) + ' has been released from a device with hardware address: hwtype=' + substring(hexstring(pkt4.htype, ''), 7, 1) + ' ' + hexstring(pkt4.mac, ':') + ifelse(option[61].exists, ', client-id: ' + hexstring(option[61].hex, ':'), '') + ifelse(pkt4.giaddr == 0.0.0.0, '', ' connected via relay at address: ' + addrtotext(pkt4.giaddr) + ifelse(option[82].option[1].exists, ', circuit-id: ' + hexstring(option[82].option[1].hex, ':'), '') + ifelse(option[82].option[2].exists, ', remote-id: ' + hexstring(option[82].option[2].hex, ':'), '') + ifelse(option[82].option[6].exists, ', subscriber-id: ' + hexstring(option[82].option[6].hex, ':'), '')), ''))"
     }
 
 .. raw:: html
@@ -1035,11 +1038,11 @@ Examples:
                 ifelse(option[50].exists,
                     addrtotext(option[50].hex),
                     addrtotext(pkt4.ciaddr)) +
-                ' has been assigned ' +
+                ' has been assigned' +
                 ifelse(option[51].exists,
-                    'for ' + uint32totext(option[51].hex) + ' seconds ',
+                    ' for ' + uint32totext(option[51].hex) + ' seconds',
                     '') +
-                'to a device with hardware address: hwtype=' + substring(hexstring(pkt4.htype, ''), 7, 1) + ' ' + hexstring(pkt4.mac, ':') +
+                ' to a device with hardware address: hwtype=' + substring(hexstring(pkt4.htype, ''), 7, 1) + ' ' + hexstring(pkt4.mac, ':') +
                 ifelse(option[61].exists,
                     ', client-id: ' + hexstring(option[61].hex, ':'),
                     '') +
@@ -1050,12 +1053,11 @@ Examples:
                         ', circuit-id: ' + hexstring(option[82].option[1].hex, ':'),
                         '') +
                     ifelse(option[82].option[2].exists,
-                        ', remote-id: ' + hexstring(option[82].option[2].hex,
-                        ':'),
-                    '') +
-                ifelse(option[82].option[6].exists,
-                    ', subscriber-id: ' + hexstring(option[82].option[6].hex, ':'),
-                    '')),
+                        ', remote-id: ' + hexstring(option[82].option[2].hex, ':'),
+                        '') +
+                    ifelse(option[82].option[6].exists,
+                        ', subscriber-id: ' + hexstring(option[82].option[6].hex, ':'),
+                        '')),
                 ifelse(pkt4.msgtype == 4 or pkt4.msgtype == 7,
                     'Address: ' +
                     ifelse(option[50].exists,
@@ -1077,7 +1079,7 @@ Examples:
                         ifelse(option[82].option[6].exists,
                             ', subscriber-id: ' + hexstring(option[82].option[6].hex, ':'),
                             '')),
-                    ''))"
+                ''))"
     }</pre>
     </details><br>
 
@@ -1226,7 +1228,7 @@ Examples:
 .. code-block:: json
 
     {
-        "request-parser-format": "ifelse(pkt6.msgtype == 8 or pkt6.msgtype == 9, ifelse(option[3].option[5].exists, 'Address: ' + addrtotext(substring(option[3].option[5].hex, 0, 16)) + ' has been released from a device with DUID: ' + hexstring(option[1].hex, ':') + ifelse(relay6[0].peeraddr == '', '', ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) + ifelse(relay6[0].option[37].exists, ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'), '') + ifelse(relay6[0].option[38].exists, ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'), '') + ifelse(relay6[0].option[18].exists, ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'), '')), '') + ifelse(option[25].option[26].exists, 'Prefix: ' + addrtotext(substring(option[25].option[26].hex, 9, 16)) + '/' + uint8totext(substring(option[25].option[26].hex, 8, 1)) + ' has been released from a device with DUID: ' + hexstring(option[1].hex, ':') + ifelse(relay6[0].peeraddr == '', '', ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) + ifelse(relay6[0].option[37].exists, ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'), '') + ifelse(relay6[0].option[38].exists, ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'), '') + ifelse(relay6[0].option[18].exists, ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'), '')), ''), '')"
+        "request-parser-format": "ifelse(pkt6.msgtype == 8 or pkt6.msgtype == 9, ifelse(option[3].option[5].exists, 'Address: ' + addrtotext(substring(option[3].option[5].hex, 0, 16)) + ' has been released from a device with DUID: ' + hexstring(option[1].hex, ':') + ifelse(relay6[0].peeraddr == '', '', ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) + ifelse(relay6[0].option[37].exists, ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'), '') + ifelse(relay6[0].option[38].exists, ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'), '') + ifelse(relay6[0].option[18].exists, ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'), '')), '') + ifelse(option[25].option[26].exists, 'Prefix: ' + addrtotext(substring(option[25].option[26].hex, 9, 16)) + '/' + uint8totext(substring(option[25].option[26].hex, 8, 1)) + ' has been released from a device with DUID: ' + hexstring(option[1].hex, ':') + ifelse(relay6[0].peeraddr == '', '', ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) + ifelse(relay6[0].option[37].exists, ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'), '') + ifelse(relay6[0].option[38].exists, ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'), '') + ifelse(relay6[0].option[18].exists, ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'), '')), ''), '')",
         "response-parser-format": "ifelse(pkt6.msgtype == 7, ifelse(option[3].option[5].exists, 'Address: ' + addrtotext(substring(option[3].option[5].hex, 0, 16)) + ' has been assigned for ' + uint32totext(substring(option[3].option[5].hex, 20, 4)) + ' seconds to a device with DUID: ' + hexstring(option[1].hex, ':') + ifelse(relay6[0].peeraddr == '', '', ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) + ifelse(relay6[0].option[37].exists, ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'), '') + ifelse(relay6[0].option[38].exists, ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'), '') + ifelse(relay6[0].option[18].exists, ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'), '')), '') + ifelse(option[25].option[26].exists, 'Prefix: ' + addrtotext(substring(option[25].option[26].hex, 9, 16)) + '/' + uint8totext(substring(option[25].option[26].hex, 8, 1)) + ' has been assigned for ' + uint32totext(substring(option[25].option[26].hex, 4, 4)) + ' seconds to a device with DUID: ' + hexstring(option[1].hex, ':') + ifelse(relay6[0].peeraddr == '', '', ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) + ifelse(relay6[0].option[37].exists, ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'), '') + ifelse(relay6[0].option[38].exists, ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'), '') + ifelse(relay6[0].option[18].exists, ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'), '')), ''), '')"
     }
 
@@ -1250,22 +1252,22 @@ Examples:
                         ifelse(relay6[0].option[18].exists,
                             ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'),
                             '')),
-                        '') +
-                    ifelse(option[25].option[26].exists,
-                        'Prefix: ' + addrtotext(substring(option[25].option[26].hex, 9, 16)) + '/' + uint8totext(substring(option[25].option[26].hex, 8, 1)) + ' has been released from a device with DUID: ' + hexstring(option[1].hex, ':') +
-                        ifelse(relay6[0].peeraddr == '',
-                            '',
-                            ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) +
-                            ifelse(relay6[0].option[37].exists,
-                                ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'),
-                                '') +
-                            ifelse(relay6[0].option[38].exists,
-                                ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'),
-                                '') +
-                            ifelse(relay6[0].option[18].exists,
-                                ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'),
-                                '')),
-                        ''),
+                    '') +
+                ifelse(option[25].option[26].exists,
+                    'Prefix: ' + addrtotext(substring(option[25].option[26].hex, 9, 16)) + '/' + uint8totext(substring(option[25].option[26].hex, 8, 1)) + ' has been released from a device with DUID: ' + hexstring(option[1].hex, ':') +
+                    ifelse(relay6[0].peeraddr == '',
+                        '',
+                        ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) +
+                        ifelse(relay6[0].option[37].exists,
+                            ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'),
+                            '') +
+                        ifelse(relay6[0].option[38].exists,
+                            ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'),
+                            '') +
+                        ifelse(relay6[0].option[18].exists,
+                            ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'),
+                            '')),
+                    ''),
                 '')",
         "response-parser-format":
             "ifelse(pkt6.msgtype == 7,
@@ -1351,9 +1353,9 @@ Examples:
             "ifelse(pkt6.msgtype == 3 or pkt6.msgtype == 5 or pkt6.msgtype == 6,
                 ifelse(option[3].option[5].exists,
                     'Address: ' + addrtotext(substring(option[3].option[5].hex, 0, 16)) + ' has been assigned for ' + uint32totext(substring(option[3].option[5].hex, 20, 4)) + ' seconds to a device with DUID: ' + hexstring(option[1].hex, ':') +
-                        ifelse(relay6[0].peeraddr == '',
-                            '',
-                            ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) +
+                    ifelse(relay6[0].peeraddr == '',
+                        '',
+                        ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) +
                         ifelse(relay6[0].option[37].exists,
                             ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'),
                             '') +
@@ -1364,53 +1366,53 @@ Examples:
                             ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'),
                             '')),
                     '') +
-                    ifelse(option[25].option[26].exists,
-                        'Prefix: ' + addrtotext(substring(option[25].option[26].hex, 9, 16)) + '/' + uint8totext(substring(option[25].option[26].hex, 8, 1)) + ' has been assigned for ' + uint32totext(substring(option[25].option[26].hex, 4, 4)) + ' seconds to a device with DUID: ' + hexstring(option[1].hex, ':') +
-                            ifelse(relay6[0].peeraddr == '',
-                                '',
-                                ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) +
-                                ifelse(relay6[0].option[37].exists,
-                                    ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'),
-                                    '') +
-                                ifelse(relay6[0].option[38].exists,
-                                    ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'),
-                                    '') +
-                                ifelse(relay6[0].option[18].exists,
-                                    ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'),
-                                    '')),
-                            ''),
+                ifelse(option[25].option[26].exists,
+                    'Prefix: ' + addrtotext(substring(option[25].option[26].hex, 9, 16)) + '/' + uint8totext(substring(option[25].option[26].hex, 8, 1)) + ' has been assigned for ' + uint32totext(substring(option[25].option[26].hex, 4, 4)) + ' seconds to a device with DUID: ' + hexstring(option[1].hex, ':') +
+                    ifelse(relay6[0].peeraddr == '',
+                        '',
+                        ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) +
+                        ifelse(relay6[0].option[37].exists,
+                            ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'),
+                            '') +
+                        ifelse(relay6[0].option[38].exists,
+                            ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'),
+                            '') +
+                        ifelse(relay6[0].option[18].exists,
+                            ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'),
+                            '')),
+                    ''),
                 ifelse(pkt6.msgtype == 8 or pkt6.msgtype == 9,
                     ifelse(option[3].option[5].exists,
                         'Address: ' + addrtotext(substring(option[3].option[5].hex, 0, 16)) + ' has been released from a device with DUID: ' + hexstring(option[1].hex, ':') +
-                            ifelse(relay6[0].peeraddr == '',
-                                '',
-                                ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) +
-                                ifelse(relay6[0].option[37].exists,
-                                    ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'),
-                                    '') +
-                                ifelse(relay6[0].option[38].exists,
-                                    ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'),
-                                    '') +
-                                ifelse(relay6[0].option[18].exists,
-                                    ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'),
-                                    '')),
-                            '') +
-                        ifelse(option[25].option[26].exists,
-                            'Prefix: ' + addrtotext(substring(option[25].option[26].hex, 9, 16)) + '/' + uint8totext(substring(option[25].option[26].hex, 8, 1)) + ' has been released from a device with DUID: ' + hexstring(option[1].hex, ':') +
-                            ifelse(relay6[0].peeraddr == '',
-                                '',
-                                ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) +
-                                ifelse(relay6[0].option[37].exists,
-                                    ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'),
-                                    '') +
-                                ifelse(relay6[0].option[38].exists,
-                                    ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'),
-                                    '') +
-                                ifelse(relay6[0].option[18].exists,
-                                    ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'),
-                                    '')),
-                            ''),
-                    ''))"
+                        ifelse(relay6[0].peeraddr == '',
+                            '',
+                            ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) +
+                            ifelse(relay6[0].option[37].exists,
+                                ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'),
+                                '') +
+                            ifelse(relay6[0].option[38].exists,
+                                ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'),
+                                '') +
+                            ifelse(relay6[0].option[18].exists,
+                                ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'),
+                                '')),
+                        '') +
+                    ifelse(option[25].option[26].exists,
+                        'Prefix: ' + addrtotext(substring(option[25].option[26].hex, 9, 16)) + '/' + uint8totext(substring(option[25].option[26].hex, 8, 1)) + ' has been released from a device with DUID: ' + hexstring(option[1].hex, ':') +
+                        ifelse(relay6[0].peeraddr == '',
+                            '',
+                            ' connected via relay at address: ' + addrtotext(relay6[0].peeraddr) + ' for client on link address: ' + addrtotext(relay6[0].linkaddr) +
+                            ifelse(relay6[0].option[37].exists,
+                                ', remote-id: ' + hexstring(relay6[0].option[37].hex, ':'),
+                                '') +
+                            ifelse(relay6[0].option[38].exists,
+                                ', subscriber-id: ' + hexstring(relay6[0].option[38].hex, ':'),
+                                '') +
+                            ifelse(relay6[0].option[18].exists,
+                                ', connected at location interface-id: ' + hexstring(relay6[0].option[18].hex, ':'),
+                                '')),
+                        ''),
+                ''))"
     }</pre>
     </details><br>