summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2024-09-25 11:22:29 (GMT)
committerBrad King <brad.king@kitware.com>2024-09-25 11:24:32 (GMT)
commit6b7e634b7c4d51cee05e01e45fffa7090b52b636 (patch)
tree47f7e38fd77fab191b0b148dff2050c88f5ad2d7 /Help/command
parent57480c767647601d6a1c541667d781838f56d8ae (diff)
downloadCMake-6b7e634b7c4d51cee05e01e45fffa7090b52b636.zip
CMake-6b7e634b7c4d51cee05e01e45fffa7090b52b636.tar.gz
CMake-6b7e634b7c4d51cee05e01e45fffa7090b52b636.tar.bz2
Help: Explicitly state include_external_msproject is only for VS generators
Fixes: #19975
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/include_external_msproject.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Help/command/include_external_msproject.rst b/Help/command/include_external_msproject.rst
index 4354654..6490856 100644
--- a/Help/command/include_external_msproject.rst
+++ b/Help/command/include_external_msproject.rst
@@ -1,7 +1,8 @@
include_external_msproject
--------------------------
-Include an external Microsoft project file in a workspace.
+Include an external Microsoft project file in the solution file produced
+by :ref:`Visual Studio Generators`. Ignored on other generators.
.. code-block:: cmake
@@ -11,9 +12,9 @@ Include an external Microsoft project file in a workspace.
[PLATFORM platformName]
dep1 dep2 ...)
-Includes an external Microsoft project in the generated workspace
-file. Currently does nothing on UNIX. This will create a target
-named ``[projectname]``. This can be used in the :command:`add_dependencies`
+Includes an external Microsoft project in the generated solution file.
+This will create a target named ``[projectname]``.
+This can be used in the :command:`add_dependencies`
command to make things depend on the external project.
``TYPE``, ``GUID`` and ``PLATFORM`` are optional parameters that allow one to