From aafbd96a1dc6863aefb85e94737b8f6dddaf0d79 Mon Sep 17 00:00:00 2001 From: Matthew Barr Date: Thu, 29 Oct 2015 17:29:24 +1100 Subject: [PATCH] docs: describe BOOST_ROOT cmake variable --- doc/dev-reference/getting_started.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/dev-reference/getting_started.rst b/doc/dev-reference/getting_started.rst index 7e43d10a..826349a7 100644 --- a/doc/dev-reference/getting_started.rst +++ b/doc/dev-reference/getting_started.rst @@ -125,8 +125,12 @@ Boost Headers Compiling Hyperscan depends on a recent version of the Boost C++ header library. If the Boost libraries are installed on the build machine in the -usual paths, CMake will find them. An alternative is to put a copy of (or a -symlink to) the boost subdirectory in ``/include/boost``. +usual paths, CMake will find them. If the Boost libraries are not installed, +the location of the Boost source tree can be specified during the CMake +configuration step using the ``BOOST_ROOT`` variable (described below). + +Another alternative is to put a copy of (or a symlink to) the boost +subdirectory in ``/include/boost``. For example: for the Boost-1.59.0 release: :: @@ -161,6 +165,8 @@ Common options for CMake include: | BUILD_STATIC_AND_SHARED| Build both static and shared Hyperscan libs. | | | Default off. | +------------------------+----------------------------------------------------+ +| BOOST_ROOT | Location of Boost source tree. | ++------------------------+----------------------------------------------------+ | DEBUG_OUTPUT | Enable very verbose debug output. Default off. | +------------------------+----------------------------------------------------+