Merge branch 'isc-master' into config-h

1 files changed, 15 insertions, 7 deletions

diff --git a/src/lib/asiolink/asio_wrapper.h b/src/lib/asiolink/asio_wrapper.h
index 402d9c755a..5369a807b8 100644
--- a/src/lib/asiolink/asio_wrapper.h
+++ b/src/lib/asiolink/asio_wrapper.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2016 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2016-2017 Internet Systems Consortium, Inc. ("ISC")
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -6,11 +6,19 @@
 #ifndef ASIO_WRAPPER_H
 #define ASIO_WRAPPER_H 1
 
-// !!! IMPORTANT !!!!
+// !!! IMPORTANT THIS IS A HACK FOR BOOST HEADERS ONLY BUILDING !!!!
+//
+// As of #5215 (Kea 1.3) The default build configuration is to link with
+// Boost's system library (boost_system) rather than build with Boost's
+// headers only. Linking with the boost_system eliminates the issue as
+// detailed below. This file exists solely for the purpose of allowing
+// people to attempt to build headers only.  ISC DOES NOT RECOMMEND
+// building Kea with Boost headers only.
+//
 // This file must be included anywhere one would normally have included
 // boost/asio.hpp.  Until the issue described below is resolved in some
-// other fashion  asio.hpp should not be included other than through
-// this file.
+// other fashion, (or we abandon support for headers only building)
+// asio.hpp MUST NOT be included other than through this file.
 //
 // The optimizer as of gcc 5.2.0, may not reliably ensure a single value
 // returned by boost::system::system_category() within a translation unit
@@ -30,12 +38,12 @@
 //
 // which involve implicit conversion of enumerates to error_code instances
 // to not evaluate correctly.  During the implicit conversion the error_code
-// instances may be assigned differeing values error_code:m_cat. This
+// instances may be assigned differing values error_code:m_cat. This
 // causes two instances of error_code which should have been equal to
 // to not be equal.
 //
-// The problem disappers if either error handling code is not built header
-// only as this results in a single definiton of system_category() supplied
+// The problem disappears if either error handling code is not built header
+// only as this results in a single definition of system_category() supplied
 // by libboost_system; or the error handling code is not optimized.
 //
 // We're doing the test here, rather than in configure to guard against the