From 6f3057f624da32ee854ba13df2bb5e399050c8c4 Mon Sep 17 00:00:00 2001
From: Gael Guennebaud <g.gael@free.fr>
Date: Thu, 21 Jun 2012 10:51:22 +0200
Subject: extend documentation of *Support modules

---
 Eigen/CholmodSupport | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'Eigen/CholmodSupport')

diff --git a/Eigen/CholmodSupport b/Eigen/CholmodSupport
index 0e1ff48e0..745b884e7 100644
--- a/Eigen/CholmodSupport
+++ b/Eigen/CholmodSupport
@@ -26,6 +26,11 @@ extern "C" {
   * \code
   * #include <Eigen/CholmodSupport>
   * \endcode
+  *
+  * In order to use this module, the cholmod headers must be accessible from the include paths, and your binary must be linked to the cholmod library and its dependencies.
+  * The dependencies depend on how cholmod has been compiled.
+  * For a cmake based project, you can use our FindCholmod.cmake module to help you in this task.
+  *
   */
 
 #include "src/misc/Solve.h"
-- 
cgit v1.2.3