summaryrefslogtreecommitdiffstats
path: root/Source/cmFileCommand.h
diff options
context:
space:
mode:
authorAlexander Neundorf <neundorf@kde.org>2007-06-13 18:36:26 (GMT)
committerAlexander Neundorf <neundorf@kde.org>2007-06-13 18:36:26 (GMT)
commit698ca6e9566aeb6bd324982f93dc8b2fae308a1e (patch)
tree1bc0d58533234d270a42cbb2656bdf2aa1faa9d9 /Source/cmFileCommand.h
parent8c4fc5fa71a453b3119cd1da58852d780f25ffbc (diff)
downloadCMake-698ca6e9566aeb6bd324982f93dc8b2fae308a1e.zip
CMake-698ca6e9566aeb6bd324982f93dc8b2fae308a1e.tar.gz
CMake-698ca6e9566aeb6bd324982f93dc8b2fae308a1e.tar.bz2
STYLE: add documentation for FILE(REMOVE ...) and FILE(REMOVE_RECURSE ...)
FILE(REMOVE ...) works only for files, not for directories, REMOVE_RECURSE works for both, it seems having both is not necessary Alex
Diffstat (limited to 'Source/cmFileCommand.h')
-rw-r--r--Source/cmFileCommand.h12
1 files changed, 8 insertions, 4 deletions
diff --git a/Source/cmFileCommand.h b/Source/cmFileCommand.h
index 6dffd27..542410f 100644
--- a/Source/cmFileCommand.h
+++ b/Source/cmFileCommand.h
@@ -77,9 +77,9 @@ public:
" FILE(GLOB variable [RELATIVE path] [globbing expressions]...)\n"
" FILE(GLOB_RECURSE variable [RELATIVE path] \n"
" [globbing expressions]...)\n"
- " FILE(REMOVE [directory]...)\n"
- " FILE(REMOVE_RECURSE [directory]...)\n"
- " FILE(MAKE_DIRECTORY [directory]...)\n"
+ " FILE(REMOVE [file1 ...])\n"
+ " FILE(REMOVE_RECURSE [file1 ...])\n"
+ " FILE(MAKE_DIRECTORY [directory1 directory2 ...])\n"
" FILE(RELATIVE_PATH variable directory file)\n"
" FILE(TO_CMAKE_PATH path result)\n"
" FILE(TO_NATIVE_PATH path result)\n"
@@ -130,7 +130,11 @@ public:
"match the files.\n"
"Examples of recursive globbing include:\n"
" /dir/*.py - match all python files in /dir and subdirectories\n"
- "MAKE_DIRECTORY will create a directory at the specified location\n"
+ "MAKE_DIRECTORY will create the given directories, also if their parent "
+ "directories don't exist yet\n"
+ "REMOVE will remove the given files, also in subdirectories\n"
+ "REMOVE_RECURSE will remove the given files and directories, also "
+ "non-empty directories\n"
"RELATIVE_PATH will determine relative path from directory to the given"
" file.\n"
"TO_CMAKE_PATH will convert path into a cmake style path with unix /. "