summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2016-06-21 09:31:42 -0400
committerBrad King <brad.king@kitware.com>2016-06-21 09:33:35 -0400
commitd3e538eabbb329dcff86ea740a056964b0e2800d (patch)
treee8f752b4b96c67cb2cae7cf804d6142347ac7663
parent9f3546bbb44e23b97ea226fce155330eb352f75b (diff)
downloadcmake-d3e538eabbb329dcff86ea740a056964b0e2800d.tar.gz
Help: Clarify VS_STARTUP_PROJECT documentation
Explain in what directory the property should be set to affect the corresponding ``.sln`` file. Suggested-by: Stephen Kelly <steveire@gmail.com>
-rw-r--r--Help/prop_dir/VS_STARTUP_PROJECT.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/Help/prop_dir/VS_STARTUP_PROJECT.rst b/Help/prop_dir/VS_STARTUP_PROJECT.rst
index edd4832437..04441b6218 100644
--- a/Help/prop_dir/VS_STARTUP_PROJECT.rst
+++ b/Help/prop_dir/VS_STARTUP_PROJECT.rst
@@ -3,10 +3,16 @@ VS_STARTUP_PROJECT
Specify the default startup project in a Visual Studio solution.
+The :ref:`Visual Studio Generators` create a ``.sln`` file for each directory
+whose ``CMakeLists.txt`` file calls the :command:`project` command. Set this
+property in the same directory as a :command:`project` command call (e.g. in
+the top-level ``CMakeLists.txt`` file) to specify the default startup project
+for the correpsonding solution file.
+
The property must be set to the name of an existing target. This
will cause that project to be listed first in the generated solution
file causing Visual Studio to make it the startup project if the
solution has never been opened before.
-If this property is not specified, then the "ALL_BUILD" project
+If this property is not specified, then the ``ALL_BUILD`` project
will be the default.