Help: Clarify how package resolve mode is intended to be used

Fixes: #23223
This commit is contained in:
Carsten Rudolph 2022-02-15 10:16:38 +01:00 committed by Brad King
parent f320a31087
commit d92469e572
3 changed files with 12 additions and 8 deletions

View File

@ -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``

View File

@ -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.

View File

@ -19,7 +19,10 @@ Presets
which allows the files to include other files.
* :manual:`cmake-presets(7)` gained support for specifying the
``resolvePackageReferences`` command line option in a build preset.
``resolvePackageReferences`` command line option in a build preset to control
restoration behavior of package references from external package managers.
Currently this is only supported by the Visual Studio generator to support
restoring packages from NuGet. Other generators ignore this option.
Generators
----------