From: Tomek Mrugalski <tomasz@isc.org>
Date: Sat, 31 Oct 2015 08:32:28 +0000 (+0900)
Subject: [4107] Added several comments.
X-Git-Tag: trac4109_base^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e15b2e1ebc65fac47b005088ed724f494ce30eb9;p=thirdparty%2Fkea.git

[4107] Added several comments.
---

diff --git a/src/lib/dhcp/dhcp6.h b/src/lib/dhcp/dhcp6.h
index 8764428812..be4feeffc9 100644
--- a/src/lib/dhcp/dhcp6.h
+++ b/src/lib/dhcp/dhcp6.h
@@ -222,7 +222,8 @@ extern const int dhcpv6_type_name_max;
 // Taken from http://www.iana.org/assignments/enterprise-numbers
 #define ENTERPRISE_ID_ISC 2495
 
-/* DHCPv4-over-DHCPv6 (RFC 7341) inter-process communication */
+/* DHCPv4-over-DHCPv6 (RFC 7341) inter-process communication. These are option
+   codes for the ISC vendor specific options used in 4o6 */
 #define ISC_V6_4O6_INTERFACE                 60000
 #define ISC_V6_4O6_SRC_ADDRESS               60001
 
@@ -301,8 +302,7 @@ extern const int dhcpv6_type_name_max;
 #define IRT_DEFAULT     86400
 #define IRT_MINIMUM     600
 
-/* DHCPv4-query message flags */
-
+/* DHCPv4-query message flags (see RFC7341) */
 #define DHCPV4_QUERY_FLAGS_UNICAST (1 << 23)
 
 #endif /* DHCP6_H */
diff --git a/src/lib/dhcp/std_option_defs.h b/src/lib/dhcp/std_option_defs.h
index a12f9d00f6..b9fbb98fc6 100644
--- a/src/lib/dhcp/std_option_defs.h
+++ b/src/lib/dhcp/std_option_defs.h
@@ -374,7 +374,12 @@ const OptionDefParams OPTION_DEF_PARAMS6[] = {
 const int OPTION_DEF_PARAMS_SIZE6  =
     sizeof(OPTION_DEF_PARAMS6) / sizeof(OPTION_DEF_PARAMS6[0]);
 
-/// @brief Definitions of private DHCPv6 options
+/// @brief Definitions of vendor-specific DHCPv6 options, defined by ISC.
+/// 4o6-* options are used for inter-process communication. For details, see
+/// http://kea.isc.org/wiki/Dhcp4o6Design
+///
+/// @todo: As those options are defined by ISC, they do not belong in std_option_defs.h.
+///        We need to move them to a separate file, e.g. isc_option_defs.h
 const OptionDefParams ISC_V6_DEFS[] = {
     { "4o6-interface", ISC_V6_4O6_INTERFACE, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
     { "4o6-source-address", ISC_V6_4O6_SRC_ADDRESS, OPT_IPV6_ADDRESS_TYPE, false, NO_RECORD_DEF, "" }