summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2024-02-06 14:28:22 (GMT)
committerBrad King <brad.king@kitware.com>2024-02-06 14:29:11 (GMT)
commit2ce6337503538bfbc73b615d04ffe7afe7a7a668 (patch)
tree20e389e03874abcbb3aad818aa6a5ebe6f099508 /Help
parent23d7863375a94395fa6d637b55c64c7a376f1581 (diff)
downloadCMake-2ce6337503538bfbc73b615d04ffe7afe7a7a668.zip
CMake-2ce6337503538bfbc73b615d04ffe7afe7a7a668.tar.gz
CMake-2ce6337503538bfbc73b615d04ffe7afe7a7a668.tar.bz2
Help: Reword if(EXISTS) suggestion to prefer if(IS_READABLE)
Diffstat (limited to 'Help')
-rw-r--r--Help/command/if.rst7
1 files changed, 3 insertions, 4 deletions
diff --git a/Help/command/if.rst b/Help/command/if.rst
index 1afbe04..a4ccd97 100644
--- a/Help/command/if.rst
+++ b/Help/command/if.rst
@@ -178,10 +178,9 @@ File Operations
False if the given path is an empty string.
- .. warning::
- To check the readability of a file, use preferably ``if(IS_READABLE)``
- because this test will evolve to check file existence only in a future
- release.
+ .. note::
+ Prefer ``if(IS_READABLE)`` to check file readability. ``if(EXISTS)``
+ may be changed in the future to to only check file existence.
.. signature:: if(IS_READABLE <path-to-file-or-directory>)