diff options
| author | Shane Parris <shane.lee.parris@gmail.com> | 2018-02-14 16:36:12 (GMT) |
|---|---|---|
| committer | Shane Parris <shane.lee.parris@gmail.com> | 2018-04-02 03:16:13 (GMT) |
| commit | 6c4f8b4596fb48f5eeea905b7fbdd9350b9e7838 (patch) | |
| tree | a1381bea7f8c2f6d33ef2564a4ff623417cf863d /Help/command/file.rst | |
| parent | 20612978c8d0880606632bf46f567218eae0b37b (diff) | |
| download | CMake-6c4f8b4596fb48f5eeea905b7fbdd9350b9e7838.zip CMake-6c4f8b4596fb48f5eeea905b7fbdd9350b9e7838.tar.gz CMake-6c4f8b4596fb48f5eeea905b7fbdd9350b9e7838.tar.bz2 | |
Adjust help documentation for file(GLOB), add topic notes
Diffstat (limited to 'Help/command/file.rst')
| -rw-r--r-- | Help/command/file.rst | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/Help/command/file.rst b/Help/command/file.rst index 5e18077..43ce3d9 100644 --- a/Help/command/file.rst +++ b/Help/command/file.rst @@ -98,10 +98,10 @@ command. :: file(GLOB <variable> - [LIST_DIRECTORIES true|false] [RELATIVE <path>] + [LIST_DIRECTORIES true|false] [RELATIVE <path>] [CONFIGURE_DEPENDS] [<globbing-expressions>...]) file(GLOB_RECURSE <variable> [FOLLOW_SYMLINKS] - [LIST_DIRECTORIES true|false] [RELATIVE <path>] + [LIST_DIRECTORIES true|false] [RELATIVE <path>] [CONFIGURE_DEPENDS] [<globbing-expressions>...]) Generate a list of files that match the ``<globbing-expressions>`` and @@ -110,6 +110,11 @@ regular expressions, but much simpler. If ``RELATIVE`` flag is specified, the results will be returned as relative paths to the given path. The results will be ordered lexicographically. +If the ``CONFIGURE_DEPENDS`` flag is specified, CMake will add logic +to the main build system check target to rerun the flagged ``GLOB`` commands +at build time. If any of the outputs change, CMake will regenerate the build +system. + By default ``GLOB`` lists directories - directories are omitted in result if ``LIST_DIRECTORIES`` is set to false. @@ -118,6 +123,10 @@ By default ``GLOB`` lists directories - directories are omitted in result if 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. + The ``CONFIGURE_DEPENDS`` flag may not work reliably on all generators, or if + a new generator is added in the future that cannot support it, projects using + it will be stuck. Even if ``CONFIGURE_DEPENDS`` works reliably, there is + still a cost to perform the check on every rebuild. Examples of globbing expressions include:: |