Преглед на файлове

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.
Brad King преди 17 години
родител
ревизия
9b8d30081c
променени са 1 файла, в които са добавени 4 реда и са изтрити 2 реда
  1. 4 2
      Source/cmFindBase.cxx

+ 4 - 2
Source/cmFindBase.cxx

@@ -61,8 +61,10 @@ cmFindBase::cmFindBase()
     "a cmake style list of paths.  For example ENV PATH would be a way "
     "a cmake style list of paths.  For example ENV PATH would be a way "
     "to list the system path variable. The argument "
     "to list the system path variable. The argument "
     "after DOC will be used for the documentation string in "
     "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 "
     "If NO_DEFAULT_PATH is specified, then no additional paths are "
     "added to the search. "
     "added to the search. "
     "If NO_DEFAULT_PATH is not specified, the search process is as follows:\n"
     "If NO_DEFAULT_PATH is not specified, the search process is as follows:\n"