CMake: Clarify the documentation for if(f1 IS_NEWER_THAN f2)

...comparison operator in the IF command. In the event of
a tie, we intentionally return "true" so that dependent
build operations are guaranteed to occur until one file
is definitively newer than the other file.

A tie means we're not sure, so return true to be on the
safe side.
This commit is contained in:
David Cole 2012-08-15 19:52:21 -04:00
parent addefc2ae3
commit 0eaaa863ed
1 changed files with 6 additions and 1 deletions

View File

@ -149,7 +149,12 @@ public:
" if(file1 IS_NEWER_THAN file2)\n" " if(file1 IS_NEWER_THAN file2)\n"
"True if file1 is newer than file2 or if one of the two files " "True if file1 is newer than file2 or if one of the two files "
"doesn't exist. " "doesn't exist. "
"Behavior is well-defined only for full paths.\n" "Behavior is well-defined only for full paths. "
"If the file time stamps are exactly the same, an "
"IS_NEWER_THAN comparison returns true, so that any dependent "
"build operations will occur in the event of a tie. "
"This includes the case of passing the same file name for both "
"file1 and file2.\n"
" if(IS_DIRECTORY directory-name)\n" " if(IS_DIRECTORY directory-name)\n"
"True if the given name is a directory. " "True if the given name is a directory. "
"Behavior is well-defined only for full paths.\n" "Behavior is well-defined only for full paths.\n"