summaryrefslogtreecommitdiffstats
path: root/Source/cmIfCommand.h
diff options
context:
space:
mode:
authorDavid Cole <david.cole@kitware.com>2012-08-15 23:52:21 (GMT)
committerDavid Cole <david.cole@kitware.com>2012-08-15 23:52:21 (GMT)
commit0eaaa863ed38ce95727e9743ca63a86ca2a7638e (patch)
treeb76a53f109f533dba4e1c46340967d19cb8bc191 /Source/cmIfCommand.h
parentaddefc2ae3b33a75a7152730146b46b319118a24 (diff)
downloadCMake-0eaaa863ed38ce95727e9743ca63a86ca2a7638e.zip
CMake-0eaaa863ed38ce95727e9743ca63a86ca2a7638e.tar.gz
CMake-0eaaa863ed38ce95727e9743ca63a86ca2a7638e.tar.bz2
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.
Diffstat (limited to 'Source/cmIfCommand.h')
-rw-r--r--Source/cmIfCommand.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/Source/cmIfCommand.h b/Source/cmIfCommand.h
index 4893a17..0a1fe06 100644
--- a/Source/cmIfCommand.h
+++ b/Source/cmIfCommand.h
@@ -149,7 +149,12 @@ public:
" if(file1 IS_NEWER_THAN file2)\n"
"True if file1 is newer than file2 or if one of the two files "
"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"
"True if the given name is a directory. "
"Behavior is well-defined only for full paths.\n"