]> git.ipfire.org Git - thirdparty/vectorscan.git/commitdiff
docs: describe BOOST_ROOT cmake variable
authorMatthew Barr <matthew.barr@intel.com>
Thu, 29 Oct 2015 06:29:24 +0000 (17:29 +1100)
committerMatthew Barr <matthew.barr@intel.com>
Fri, 30 Oct 2015 00:28:38 +0000 (11:28 +1100)
doc/dev-reference/getting_started.rst

index 7e43d10aa651f506cf96fe25d1213edd5da3d0bb..826349a7f2d23241b282f98aaefc7968e3334d3a 100644 (file)
@@ -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 ``<hyperscan-source-path>/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 ``<hyperscan-source-path>/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.     |
 +------------------------+----------------------------------------------------+