Warn in find(GLOB) docs about bad use case (#11617)

The first instinct of a lot of users is to use file(GLOB) to assemble
lists of sources.  Add a warning to the help text stating that it should
not be used for this purpose and briefly explain why.

Suggested-By: Ryan Pavlik
This commit is contained in:
Brad King 2010-12-16 15:49:32 -05:00
parent 72ebd4ee12
commit 26cc29a8e2
1 changed files with 6 additions and 1 deletions

View File

@ -116,7 +116,12 @@ public:
"expressions and store it into the variable. Globbing expressions "
"are similar to regular expressions, but much simpler. If RELATIVE "
"flag is specified for an expression, the results will be returned "
"as a relative path to the given path.\n"
"as a relative path to the given path. "
"(We do not recommend using GLOB to collect a list of source files "
"from your source tree. If no CMakeLists.txt file changes when a "
"source is added or removed then the generated build system cannot "
"know when to ask CMake to regenerate.)"
"\n"
"Examples of globbing expressions include:\n"
" *.cxx - match all files with extension cxx\n"
" *.vt? - match all files with extension vta,...,vtz\n"