summaryrefslogtreecommitdiffstats
path: root/Help/manual
diff options
context:
space:
mode:
authorscivision <scivision@users.noreply.github.com>2023-02-14 18:38:59 (GMT)
committerscivision <scivision@users.noreply.github.com>2023-02-14 18:38:59 (GMT)
commit615ba911c4ecaacb6b16f4b85205779541953d3c (patch)
treea5cdaf79d4bdd58d2e358bf28d1e4b6795aaf5c5 /Help/manual
parent68a46505a30d40d3cd8e5535789b2cd231f44255 (diff)
downloadCMake-615ba911c4ecaacb6b16f4b85205779541953d3c.zip
CMake-615ba911c4ecaacb6b16f4b85205779541953d3c.tar.gz
CMake-615ba911c4ecaacb6b16f4b85205779541953d3c.tar.bz2
Help: cmake(1): sleep can have floating point value
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/cmake.1.rst11
1 files changed, 9 insertions, 2 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index e48ecd9..76dc883 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -1080,11 +1080,18 @@ Available commands are:
situations instead. Use ``--`` to stop interpreting options and treat all
remaining arguments as paths, even if they start with ``-``.
-.. option:: sleep <number>...
+.. option:: sleep <number>
.. versionadded:: 3.0
- Sleep for given number of seconds.
+ Sleep for ``<number>`` seconds. ``<number>`` may be a floating point number.
+ A practical minimum is about 0.1 seconds due to overhead in starting/stopping
+ CMake executable. This can be useful in a CMake script to insert a delay:
+
+ .. code-block:: cmake
+
+ # Sleep for about 0.5 seconds
+ execute_process(COMMAND ${CMAKE_COMMAND} -E sleep 0.5)
.. option:: tar [cxt][vf][zjJ] file.tar [<options>] [--] [<pathname>...]