summaryrefslogtreecommitdiffstats
path: root/Help/manual
diff options
context:
space:
mode:
authorCarsten Rudolph <18394207+crud89@users.noreply.github.com>2022-02-15 09:16:38 (GMT)
committerBrad King <brad.king@kitware.com>2022-02-15 15:20:14 (GMT)
commitd92469e57210d6b4e9a2733d3477ae44a6cf9735 (patch)
treee07a11d83186c8542298a24accc6ddb530ad495a /Help/manual
parentf320a31087c4efc07e7d10b621ec45dd0350c83a (diff)
downloadCMake-d92469e57210d6b4e9a2733d3477ae44a6cf9735.zip
CMake-d92469e57210d6b4e9a2733d3477ae44a6cf9735.tar.gz
CMake-d92469e57210d6b4e9a2733d3477ae44a6cf9735.tar.bz2
Help: Clarify how package resolve mode is intended to be used
Fixes: #23223
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/cmake-presets.7.rst7
-rw-r--r--Help/manual/cmake.1.rst8
2 files changed, 8 insertions, 7 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst
index 346e821..69d0543 100644
--- a/Help/manual/cmake-presets.7.rst
+++ b/Help/manual/cmake-presets.7.rst
@@ -479,9 +479,10 @@ that may contain the following fields:
An optional string that specifies the package resolve mode. This is
allowed in preset files specifying version ``4`` or above.
- This field overwrites the ``--resolve-package-references`` command line
- parameter. If there are no targets that define package references, this
- option does nothing. Valid values are:
+ Package references are used to define dependencies to packages from
+ external package managers. Currently only NuGet in combination with the
+ Visual Studio generator is supported. If there are no targets that define
+ package references, this option does nothing. Valid values are:
``on``
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index c68e7a9..f7d4f6b 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -467,10 +467,10 @@ following options:
``--resolve-package-references=<on|off|only>``
.. versionadded:: 3.23
- Resolve remote package references (e.g. NuGet packages) before build.
- When set to ``on`` (default), packages will be restored before building a
- target. When set to ``only``, the packages will be restored, but no build
- will be performed. When set to ``off``, no packages will be restored.
+ Resolve remote package references from external package managers (e.g. NuGet)
+ before build. When set to ``on`` (default), packages will be restored before
+ building a target. When set to ``only``, the packages will be restored, but no
+ build will be performed. When set to ``off``, no packages will be restored.
If the target does not define any package references, this option does nothing.