Help: Explicitly state include_external_msproject is only for VS generators

Fixes: #19975
This commit is contained in:
Brad King 2024-09-25 07:22:29 -04:00
parent 57480c7676
commit 6b7e634b7c

View File

@ -1,7 +1,8 @@
include_external_msproject 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 .. code-block:: cmake
@ -11,9 +12,9 @@ Include an external Microsoft project file in a workspace.
[PLATFORM platformName] [PLATFORM platformName]
dep1 dep2 ...) dep1 dep2 ...)
Includes an external Microsoft project in the generated workspace Includes an external Microsoft project in the generated solution file.
file. Currently does nothing on UNIX. This will create a target This will create a target named ``[projectname]``.
named ``[projectname]``. This can be used in the :command:`add_dependencies` This can be used in the :command:`add_dependencies`
command to make things depend on the external project. command to make things depend on the external project.
``TYPE``, ``GUID`` and ``PLATFORM`` are optional parameters that allow one to ``TYPE``, ``GUID`` and ``PLATFORM`` are optional parameters that allow one to