summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-01-24 16:46:15 (GMT)
committerKitware Robot <kwrobot@kitware.com>2022-01-24 16:46:29 (GMT)
commit63154cbf4501e11cae281eccbbdf9eceb453dae1 (patch)
treebe8490cf000e62f532a40fb37f652f9f4e7e477e /Help/variable
parent25441f26171531ff114f3b9a6fad6ee2edc7ef29 (diff)
parent9aa7831f05e924830848822aecdb43aa7261bc11 (diff)
downloadCMake-63154cbf4501e11cae281eccbbdf9eceb453dae1.zip
CMake-63154cbf4501e11cae281eccbbdf9eceb453dae1.tar.gz
CMake-63154cbf4501e11cae281eccbbdf9eceb453dae1.tar.bz2
Merge topic 'vs-package-restore'
9aa7831f05 Presets: add resolve packages setting to build presets. b2f8f0bb87 cmGlobalVisualStudio10Generator: Auto restore NuGet packages. 193b8fca52 cmBuildOptions: Split build arguments into separate object. 6a10103493 Help: Update preset schema description for version 3 entries. Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6761
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/CMAKE_VS_NUGET_PACKAGE_RESTORE.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_VS_NUGET_PACKAGE_RESTORE.rst b/Help/variable/CMAKE_VS_NUGET_PACKAGE_RESTORE.rst
new file mode 100644
index 0000000..7160726
--- /dev/null
+++ b/Help/variable/CMAKE_VS_NUGET_PACKAGE_RESTORE.rst
@@ -0,0 +1,22 @@
+CMAKE_VS_NUGET_PACKAGE_RESTORE
+------------------------------
+
+.. versionadded:: 3.23
+
+When using a Visual Studio generator, this cache variable controls
+if msbuild should automatically attempt to restore NuGet packages
+prior to a build. NuGet packages can be defined using the
+:prop_tgt:`VS_PACKAGE_REFERENCES` property on a target. If no
+package references are defined, this setting will do nothing.
+
+The command line option ``--resolve-package-references`` can be used
+alternatively to control the resolve behavior globally. This option
+will take precedence over the cache variable.
+
+Targets that use the :prop_tgt:`DOTNET_SDK` are required to run a
+restore before building. Disabling this option may cause the build
+to fail in such projects.
+
+This setting is stored as a cache entry. Default value is ``ON``.
+
+See also the :prop_tgt:`VS_PACKAGE_REFERENCES` property.