summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2008-10-14 12:43:19 (GMT)
committerBrad King <brad.king@kitware.com>2008-10-14 12:43:19 (GMT)
commit9b8d30081c66082dfc7df79ff1cc9b3348bb5308 (patch)
tree26b3e51fe567a0586eb3b1f7c050bc484ba1da84
parent4b303ddd3801ef39fda6a6e816005d0a5881380c (diff)
downloadCMake-9b8d30081c66082dfc7df79ff1cc9b3348bb5308.zip
CMake-9b8d30081c66082dfc7df79ff1cc9b3348bb5308.tar.gz
CMake-9b8d30081c66082dfc7df79ff1cc9b3348bb5308.tar.bz2
ENH: Clarify PATH_SUFFIXES documentation
This clarifies documentation of the find_* commands' PATH_SUFFIXES option. The option adds paths with the suffixes but does not remove the paths without the suffixes.
-rw-r--r--Source/cmFindBase.cxx6
1 files changed, 4 insertions, 2 deletions
diff --git a/Source/cmFindBase.cxx b/Source/cmFindBase.cxx
index 3b2a704..53894e8 100644
--- a/Source/cmFindBase.cxx
+++ b/Source/cmFindBase.cxx
@@ -61,8 +61,10 @@ cmFindBase::cmFindBase()
"a cmake style list of paths. For example ENV PATH would be a way "
"to list the system path variable. The argument "
"after DOC will be used for the documentation string in "
- "the cache. PATH_SUFFIXES can be used to give sub directories "
- "that will be appended to the search paths.\n"
+ "the cache. "
+ "PATH_SUFFIXES specifies additional subdirectories to check below "
+ "each search path."
+ "\n"
"If NO_DEFAULT_PATH is specified, then no additional paths are "
"added to the search. "
"If NO_DEFAULT_PATH is not specified, the search process is as follows:\n"