Fix documentation of BOOST_NETWORK_ENABLE_HTTPS

deanberris · deanberris · commit 34820129581f · 2014-09-02T23:52:36.000+10:00
Fixes cpp-netlib#429 Addresses comments by @povilasb on improvements to previous PR that documents the circumstances where BOOST_NETWORK_ENABLE_HTTPS would be set and be useful.
diff --git a/libs/network/doc/getting_started.rst b/libs/network/doc/getting_started.rst
@@ -133,8 +133,13 @@ additional parameters::
 
 If you intend to use the SSL support when using the HTTP client libraries in
 :mod:`cpp-netlib`, you may need to build it with OpenSSL_ installed or at least
-available to CMake. One example for building the library with OpenSSL_ support
-is by doing the following::
+available to CMake. If you have the development headers for OpenSSL_ installed
+on your system when you build :mod:`cpp-netlib`, CMake will be able to detect it
+and set the ``BOOST_NETWORK_ENABLE_HTTPS`` macro when building the library to
+support HTTPS URIs.
+
+One example for building the library with OpenSSL_ support with a custom
+(non-installed) version of OpenSSL_ is by doing the following::
 
     $ cmake -DCMAKE_BUILD_TYPE=Debug \
     >       -DCMAKE_C_COMPILER=clang \
diff --git a/libs/network/doc/reference/http_client.rst b/libs/network/doc/reference/http_client.rst
@@ -39,8 +39,19 @@ only in the following situations:
     code.** It is best to define this either at compile-time of all code using
     the library, or before including any of the client headers.
 
-.. _OpenSSL: http://www.openssl.org/
+To use the client implementations that support HTTPS URIs, you may explicitly
+do the following:
+
+.. code-block:: c++
 
+   #define BOOST_NETWORK_ENABLE_HTTPS
+   #include <boost/network/include/http/client.hpp>
+
+This forces HTTPS support to be enabled and forces a dependency on OpenSSL_.
+This dependency is imposed by `Boost.Asio`_
+
+.. _OpenSSL: http://www.openssl.org/
+.. _`Boost.Asio`: http://www.boost.org/libs/asio
 
 Implementations
 ---------------
