STYLE: fix docs

This commit is contained in:
Ken Martin 2005-11-16 11:25:47 -05:00
parent f6a6522801
commit 1d4b3f8388

View File

@ -73,27 +73,27 @@ public:
" FILE(RELATIVE_PATH variable directory file)\n"
"WRITE will write a message into a file called 'filename'. It "
"overwrites the file if it already exists, and creates the file "
"if it does not exists.\n"
"if it does not exist.\n"
"APPEND will write a message into a file same as WRITE, except "
"it will append it to the end of the file\n"
"NOTE: When using FILE WRITE and FILE APPEND, the produced file "
"cannot be used as an input to CMake (CONFIGURE_FILE, source file ...) "
"because it will lead to infinite loop. Use CONFIGURE_FILE if you "
"because it will lead to an infinite loop. Use CONFIGURE_FILE if you "
"want to generate input files to CMake.\n"
"READ will read the content of a file and store it into the "
"variable.\n"
"GLOB will generate a list of all files that match the globbing "
"expressions and store it into the variable. Globbing expressions "
"are similar to regular expressions, but much simpler..\n"
"Examples of globbing expressions:\n"
"are similar to regular expressions, but much simpler.\n"
"Examples of globbing expressions include:\n"
" *.cxx - match all files with extension cxx\n"
" *.vt? - match all files with extension vta, vtb, ... vtz\n"
" *.vt? - match all files with extension vta,...,vtz\n"
" f[3-5].txt - match files f3.txt, f4.txt, f5.txt\n"
"GLOB_RECURSE will generate similar list as the regular GLOB, except "
"it will traverse all the subdirectories of the matched directory and "
"match the files.\n"
"Example of recursive globbing:\n"
" /dir/*.py - match all python files /dir and subdirectories\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"
"RELATIVE_PATH will determine relative path from directory to the given file";
}