Document CMAKE_INSTALL_PREFIX in CMAKE_SYSTEM_PREFIX_PATH

Add documentation to both variables to indicate that the install prefix
is also searched.
This commit is contained in:
Brad King 2013-06-17 08:40:44 -04:00
parent dea8271840
commit a0b37d7e3b
1 changed files with 6 additions and 1 deletions

View File

@ -648,6 +648,10 @@ void cmDocumentVariables::DefineVariables(cmake* cm)
"WARNING: DESTDIR may not be used on Windows because installation"
" prefix usually contains a drive letter like in \"C:/Program Files\""
" which cannot be prepended with some other prefix."
"\n"
"The installation prefix is also added to CMAKE_SYSTEM_PREFIX_PATH "
"so that find_package, find_program, find_library, find_path, and "
"find_file will search the prefix for other software."
,false,
"Variables That Change Behavior");
@ -725,7 +729,8 @@ void cmDocumentVariables::DefineVariables(cmake* cm)
"adds /bin to each of the directories in the path, FIND_LIBRARY() "
"appends /lib to each of the directories, and FIND_PATH() and "
"FIND_FILE() append /include . By default this contains the standard "
"directories for the current system. It is NOT intended "
"directories for the current system and the CMAKE_INSTALL_PREFIX. "
"It is NOT intended "
"to be modified by the project, use CMAKE_PREFIX_PATH for this. See also "
"CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_SYSTEM_LIBRARY_PATH, "
"CMAKE_SYSTEM_PROGRAM_PATH, and CMAKE_SYSTEM_IGNORE_PATH.", false,