From: Thomas Markwalder <tmark@isc.org>
Date: Thu, 15 Aug 2019 15:03:12 +0000 (-0400)
Subject: [#761,!447] Updated doc and added ChangeLog
X-Git-Tag: Kea-1.6.0~41^2~71
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=215d84f00208ac8a2710c28abc3386d6b765ede6;p=thirdparty%2Fkea.git

[#761,!447] Updated doc and added ChangeLog
---

diff --git a/ChangeLog b/ChangeLog
index de7d28cffc..16af24aeba 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+1645.	[func]		tmark
+	Binary option data may now be specified as a single-quoted
+	text string, within double quotes: "'some text'".  This is
+	handy for binary options that convey text such as urls or
+	file names.
+	(Gitlab #761,!447, git TBD)
+
 1644.	[doc]		marcin, fdupont
 	Added a warning about class dependence on built-in classes.
 	(Gitlab #727,!466, git 9977d2927cf9b9cf1cd13de30aa5551ca900165b)
diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst
index 77eb5bb019..0789f02648 100644
--- a/doc/sphinx/arm/dhcp4-srv.rst
+++ b/doc/sphinx/arm/dhcp4-srv.rst
@@ -1401,6 +1401,27 @@ Care should be taken to use proper encoding when using hexadecimal
 format; Kea's ability to validate data correctness in hexadecimal is
 limited.
 
+
+As of Kea 1.6.0, it is also possible to specify data for binary options as
+a single-quoted text string within double quotes as shown (note that
+``csv-format`` must be set to false):
+
+::
+
+   "Dhcp4": {
+       "option-data": [
+           {
+               "name": "user-class",
+               "code": 77,
+               "space": "dhcp4",
+               "csv-format": false,
+               "data": "'convert this text to binary'"
+           },
+           ...
+       ],
+       ...
+   }
+
 Most of the parameters in the "option-data" structure are optional and
 can be omitted in some circumstances, as discussed in :ref:`dhcp4-option-data-defaults`.
 
diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst
index 4bbf944d61..4ab6bac39d 100644
--- a/doc/sphinx/arm/dhcp6-srv.rst
+++ b/doc/sphinx/arm/dhcp6-srv.rst
@@ -1162,6 +1162,26 @@ Care should be taken to use proper encoding when using hexadecimal
 format; Kea's ability to validate data correctness in hexadecimal is
 limited.
 
+As of Kea 1.6.0, it is also possible to specify data for binary options as
+a single-quoted text string within double quotes as shown (note that
+``csv-format`` must be set to false):
+
+::
+
+   "Dhcp6": {
+       "option-data": [
+           {
+               "name": "subscriber-id",
+               "code": 38,
+               "space": "dhcp6",
+               "csv-format": false,
+               "data": "'convert this text to binary'"
+           },
+           ...
+       ],
+       ...
+   }
+
 Most of the parameters in the "option-data" structure are optional and
 can be omitted in some circumstances, as discussed in :ref:`dhcp6-option-data-defaults`.
 Only one of name or code