summaryrefslogtreecommitdiff
path: root/Modules/readme.txt
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2006-11-01 09:06:27 -0500
committerBrad King <brad.king@kitware.com>2006-11-01 09:06:27 -0500
commitcc7bfeb6e4bb579956980df768c19c3d30e82c15 (patch)
treead371ed6cf45da8440d41d2f46dcd525ca26341a /Modules/readme.txt
parentdb4c5c5191b3f7b6a18f0a32304b2652d1b64efd (diff)
downloadcmake-cc7bfeb6e4bb579956980df768c19c3d30e82c15.tar.gz
ENH: Added XXX_RUNTIME_LIBRARY_DIRS as a suggested variable.
Diffstat (limited to 'Modules/readme.txt')
-rw-r--r--Modules/readme.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/Modules/readme.txt b/Modules/readme.txt
index 4c31b6b691..2e630116b1 100644
--- a/Modules/readme.txt
+++ b/Modules/readme.txt
@@ -15,6 +15,9 @@ XXX_VERSION_YY Expect Version YY if true. Make sure at most one of these is eve
XXX_WRAP_YY If False, do not try to use the relevent CMake wrapping command.
XXX_YY_FOUND If False, optional YY part of XXX sytem is not available.
XXX_FOUND Set to false, or undefined, if we haven't found, or don't want to use XXX.
+XXX_RUNTIME_LIBRARY_DIRS Optionally, the runtime library search path for use when running an executable linked to shared libraries.
+ The list should be used by user code to create the PATH on windows or LD_LIBRARY_PATH on unix.
+ This should not be a cache entry.
You do not have to provide all of the above variables. You should provide XXX_FOUND under most circumstances. If XXX is a library, then XXX_LIBRARIES, should also be defined, and XXX_INCLUDE_DIRS should usually be defined (I guess libm.a might be an exception)