STYLE: Fix documentation bug regarding Boost_<COMPONENT>_LIBRARY (COMPONENT

should be uppercase).
This commit is contained in:
Philip Lowman 2009-03-02 21:09:36 -05:00
parent f0edae98ea
commit feb21f1dc0
1 changed files with 34 additions and 33 deletions

View File

@ -68,8 +68,8 @@
# #
# ============================================================================ # ============================================================================
# #
# Variables used by this module, they can change the default behaviour and need to be set # Variables used by this module, they can change the default behaviour and
# before calling find_package: # need to be set before calling find_package:
# #
# Boost_USE_MULTITHREADED Can be set to OFF to use the non-multithreaded # Boost_USE_MULTITHREADED Can be set to OFF to use the non-multithreaded
# boost libraries. If not specified, defaults # boost libraries. If not specified, defaults
@ -91,7 +91,7 @@
# reports. # reports.
# #
# Boost_COMPILER Set this to the compiler suffix used by Boost # Boost_COMPILER Set this to the compiler suffix used by Boost
# (e.g. "-gcc43") if FindBoods has problems finding # (e.g. "-gcc43") if FindBoost has problems finding
# the proper Boost installation # the proper Boost installation
# #
# These last three variables are available also as environment variables: # These last three variables are available also as environment variables:
@ -117,7 +117,7 @@
# Boost_INCLUDE_DIR This is almost the same as above, but this one is # Boost_INCLUDE_DIR This is almost the same as above, but this one is
# cached and may be modified by advanced users # cached and may be modified by advanced users
# #
# Boost_LIBRARIES Link these to use the Boost libraries that you # Boost_LIBRARIES Link to these to use the Boost libraries that you
# specified: not cached # specified: not cached
# #
# Boost_LIBRARY_DIRS The path to where the Boost library files are. # Boost_LIBRARY_DIRS The path to where the Boost library files are.
@ -137,17 +137,18 @@
# to have diagnostic information about Boost's # to have diagnostic information about Boost's
# automatic linking outputted during compilation time. # automatic linking outputted during compilation time.
# #
# For each component you list the following variables are set. # For each component you specify in find_package(), the following (UPPER-CASE)
# ATTENTION: The component names need to be in lower case, just as the boost # variables are set. You can use these variables if you would like to pick and
# library names however the CMake variables use upper case for the component # choose components for your targets instead of just using Boost_LIBRARIES.
# part. So you'd get Boost_SERIALIZATION_FOUND for example.
# #
# Boost_${COMPONENT}_FOUND True IF the Boost library "component" was found. # Boost_${COMPONENT}_FOUND True IF the Boost library "component" was found.
# Boost_${COMPONENT}_LIBRARY The absolute path of the Boost library "component". #
# Boost_${COMPONENT}_LIBRARY_DEBUG The absolute path of the debug version of the # Boost_${COMPONENT}_LIBRARY Contains the libraries for the specified Boost
# Boost library "component". # "component" (includes debug and optimized keywords
# Boost_${COMPONENT}_LIBRARY_RELEASE The absolute path of the release version of the # when needed).
# Boost library "component" #
# =====================================================================
#
# #
# Copyright (c) 2006-2008 Andreas Schneider <mail@cynapses.org> # Copyright (c) 2006-2008 Andreas Schneider <mail@cynapses.org>
# Copyright (c) 2007 Wengo # Copyright (c) 2007 Wengo