diff --git a/Help/command/file.rst b/Help/command/file.rst index 943bf7c1b8..f038871b7b 100644 --- a/Help/command/file.rst +++ b/Help/command/file.rst @@ -38,10 +38,10 @@ Synopsis `Filesystem`_ file({`GLOB`_ | `GLOB_RECURSE`_} [...] [...]) + file(`MAKE_DIRECTORY`_ [...]) + file({`REMOVE`_ | `REMOVE_RECURSE`_ } [...]) file(`RENAME`_ [...]) file(`COPY_FILE`_ [...]) - file({`REMOVE`_ | `REMOVE_RECURSE`_ } [...]) - file(`MAKE_DIRECTORY`_ [...]) file({`COPY`_ | `INSTALL`_} ... DESTINATION [...]) file(`SIZE`_ ) file(`READ_SYMLINK`_ ) @@ -691,6 +691,32 @@ Examples of recursive globbing include:: /dir/*.py - match all python files in /dir and subdirectories +.. _MAKE_DIRECTORY: + +.. code-block:: cmake + + file(MAKE_DIRECTORY [...]) + +Create the given directories and their parents as needed. + +.. _REMOVE: +.. _REMOVE_RECURSE: + +.. code-block:: cmake + + file(REMOVE [...]) + file(REMOVE_RECURSE [...]) + +Remove the given files. The ``REMOVE_RECURSE`` mode will remove the given +files and directories, also non-empty directories. No error is emitted if a +given file does not exist. Relative input paths are evaluated with respect +to the current source directory. + +.. versionchanged:: 3.15 + Empty input paths are ignored with a warning. Previous versions of CMake + interpreted empty strings as a relative path with respect to the current + directory and removed its contents. + .. _RENAME: .. code-block:: cmake @@ -725,6 +751,8 @@ The options are: [RESULT ] [ONLY_IF_DIFFERENT]) +.. versionadded:: 3.21 + Copy a file from ```` to ````. Directories are not supported. Symlinks are ignored and ````'s content is read and written to ```` as a new file. @@ -736,34 +764,17 @@ The options are: If ``RESULT`` is not specified and the operation fails, an error is emitted. ``ONLY_IF_DIFFERENT`` - If the ```` path already exists, do not replace it if it is the - same as ````. Otherwise, an error is emitted. + If the ```` path already exists, do not replace it if the file's + contents are already the same as ```` (this avoids updating + ````'s timestamp). -.. _REMOVE: -.. _REMOVE_RECURSE: +This sub-command has some similarities to :command:`configure_file` with the +``COPYONLY`` option. An important difference is that :command:`configure_file` +creates a dependency on the source file, so CMake will be re-run if it changes. +The ``file(COPY_FILE)`` sub-command does not create such a dependency. -.. code-block:: cmake - - file(REMOVE [...]) - file(REMOVE_RECURSE [...]) - -Remove the given files. The ``REMOVE_RECURSE`` mode will remove the given -files and directories, also non-empty directories. No error is emitted if a -given file does not exist. Relative input paths are evaluated with respect -to the current source directory. - -.. versionchanged:: 3.15 - Empty input paths are ignored with a warning. Previous versions of CMake - interpreted empty string as a relative path with respect to the current - directory and removed its contents. - -.. _MAKE_DIRECTORY: - -.. code-block:: cmake - - file(MAKE_DIRECTORY [...]) - -Create the given directories and their parents as needed. +See also the ``file(COPY)`` sub-command just below which provides +further file-copying capabilities. .. _COPY: .. _INSTALL: @@ -779,6 +790,11 @@ Create the given directories and their parents as needed. [[PATTERN | REGEX ] [EXCLUDE] [PERMISSIONS ...]] [...]) +.. note:: + + For a simple file copying operation, the ``file(COPY_FILE)`` sub-command + just above may be easier to use. + The ``COPY`` signature copies files, directories, and symlinks to a destination folder. Relative input paths are evaluated with respect to the current source directory, and a relative destination is diff --git a/Help/command/target_link_libraries.rst b/Help/command/target_link_libraries.rst index ac231bc8f2..c85094aa91 100644 --- a/Help/command/target_link_libraries.rst +++ b/Help/command/target_link_libraries.rst @@ -300,7 +300,7 @@ The object files associated with an object library may be referenced by the :genex:`$` generator expression. Such object files are placed on the link line *before* all libraries, regardless of their relative order. Additionally, an ordering dependency will be -added to the build sysstem to make sure the object library is up-to-date +added to the build system to make sure the object library is up-to-date before the dependent target links. For example, the code .. code-block:: cmake diff --git a/Help/variable/PROJECT_IS_TOP_LEVEL.rst b/Help/variable/PROJECT_IS_TOP_LEVEL.rst index ad61fecc05..7e407045a5 100644 --- a/Help/variable/PROJECT_IS_TOP_LEVEL.rst +++ b/Help/variable/PROJECT_IS_TOP_LEVEL.rst @@ -3,7 +3,8 @@ PROJECT_IS_TOP_LEVEL .. versionadded:: 3.21 -A boolean variable indicating whether :command:`project` was called in a top +A boolean variable indicating whether the most recently called +:command:`project` command in the current scope or above was in the top level ``CMakeLists.txt`` file. Some modules should only be included as part of the top level