aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2016-12-06 11:34:06 +0100
committerGravatar Gael Guennebaud <g.gael@free.fr>2016-12-06 11:34:06 +0100
commit0c4d05b0091c84687e2470822743e8f89d2a1ebb (patch)
treefd0360c21d0d6b26eab74275ee1651c5a3b3bcff
parente049a2a72a307cad9e078077148c6d3ee9552412 (diff)
Explain how to choose your favorite Eigen version
-rw-r--r--doc/TopicCMakeGuide.dox7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/TopicCMakeGuide.dox b/doc/TopicCMakeGuide.dox
index a540db68e..896cfa831 100644
--- a/doc/TopicCMakeGuide.dox
+++ b/doc/TopicCMakeGuide.dox
@@ -32,6 +32,11 @@ which requires at least version 3.3 of %Eigen. Here, `path-to-example-directory`
is the path to the directory that contains both `CMakeLists.txt` and
`example.cpp`.
+If you have multiple installed version of %Eigen, you can pick your favorite one by setting the \c Eigen3_DIR cmake's variable to the respective path containing the \c Eigen3*.cmake files. For instance:
+\code
+cmake path-to-example-directory -DEigen3_DIR=$HOME/mypackages/share/eigen3/cmake/
+\endcode
+
If the `REQUIRED` option is omitted when locating %Eigen using
`find_package`, one can check whether the package was found as follows:
\code{.cmake}
@@ -45,5 +50,3 @@ endif (TARGET Eigen3::Eigen)
*/
}
-
-// vim: set ft=cpp.doxygen