Help: CPack NuGet Generator page use field lists

This commit is contained in:
Alex Turbov
2023-01-30 04:54:22 +04:00
committed by Brad King
parent fbb5ac4735
commit 27d45be75d

View File

@@ -5,11 +5,11 @@ CPack NuGet Generator
When build a NuGet package there is no direct way to control an output
filename due a lack of the corresponding CLI option of NuGet, so there
is no ``CPACK_NUGET_PACKAGE_FILE_NAME`` variable. To form the output filename
is no :variable:`!CPACK_NUGET_PACKAGE_FILE_NAME` variable. To form the output filename
NuGet uses the package name and the version according to its built-in rules.
Also, be aware that including a top level directory
(``CPACK_INCLUDE_TOPLEVEL_DIRECTORY``) is ignored by this generator.
(:variable:`CPACK_INCLUDE_TOPLEVEL_DIRECTORY`) is ignored by this generator.
Variables specific to CPack NuGet generator
@@ -17,10 +17,10 @@ Variables specific to CPack NuGet generator
The CPack NuGet generator may be used to create NuGet packages using
:module:`CPack`. The CPack NuGet generator is a :module:`CPack` generator thus
it uses the ``CPACK_XXX`` variables used by :module:`CPack`.
it uses the :variable:`!CPACK_XXX` variables used by :module:`CPack`.
The CPack NuGet generator has specific features which are controlled by the
specifics ``CPACK_NUGET_XXX`` variables. In the "one per group" mode
specifics :variable:`!CPACK_NUGET_XXX` variables. In the "one per group" mode
(see :variable:`CPACK_COMPONENTS_GROUPING`), ``<compName>`` placeholder
in the variables below would contain a group name (uppercased and turned into
a "C" identifier).
@@ -31,8 +31,8 @@ List of CPack NuGet generator specific variables:
Enable component packaging for CPack NuGet generator
* Mandatory : NO
* Default : OFF
:Mandatory: No
:Default: ``OFF``
.. variable:: CPACK_NUGET_PACKAGE_NAME
CPACK_NUGET_<compName>_PACKAGE_NAME
@@ -40,26 +40,27 @@ List of CPack NuGet generator specific variables:
The NUGET package name. ``CPACK_NUGET_PACKAGE_NAME`` is used as the
package ``id`` on nuget.org_
* Mandatory : YES
* Default : :variable:`CPACK_PACKAGE_NAME`
:Mandatory: Yes
:Default: :variable:`CPACK_PACKAGE_NAME`
.. variable:: CPACK_NUGET_PACKAGE_VERSION
CPACK_NUGET_<compName>_PACKAGE_VERSION
The NuGet package version.
* Mandatory : YES
* Default : :variable:`CPACK_PACKAGE_VERSION`
:Mandatory: Yes
:Default: :variable:`CPACK_PACKAGE_VERSION`
.. variable:: CPACK_NUGET_PACKAGE_DESCRIPTION
CPACK_NUGET_<compName>_PACKAGE_DESCRIPTION
A long description of the package for UI display.
* Mandatory : YES
* Default :
:Mandatory: Yes
:Default:
- :variable:`CPACK_COMPONENT_<compName>_DESCRIPTION`,
- ``CPACK_COMPONENT_GROUP_<groupName>_DESCRIPTION``,
- :variable:`!CPACK_COMPONENT_GROUP_<groupName>_DESCRIPTION`,
- :variable:`CPACK_PACKAGE_DESCRIPTION`
.. variable:: CPACK_NUGET_PACKAGE_AUTHORS
@@ -70,8 +71,8 @@ List of CPack NuGet generator specific variables:
nuget.org_ and are used to cross-reference packages by the same
authors.
* Mandatory : YES
* Default : :variable:`CPACK_PACKAGE_VENDOR`
:Mandatory: Yes
:Default: :variable:`CPACK_PACKAGE_VENDOR`
.. variable:: CPACK_NUGET_PACKAGE_TITLE
CPACK_NUGET_<compName>_PACKAGE_TITLE
@@ -80,10 +81,11 @@ List of CPack NuGet generator specific variables:
as on nuget.org_ and the Package Manager in Visual Studio. If not
specified, the package ID is used.
* Mandatory : NO
* Default :
:Mandatory: No
:Default:
- :variable:`CPACK_COMPONENT_<compName>_DISPLAY_NAME`,
- ``CPACK_COMPONENT_GROUP_<groupName>_DISPLAY_NAME``
- :variable:`!CPACK_COMPONENT_GROUP_<groupName>_DISPLAY_NAME`
.. variable:: CPACK_NUGET_PACKAGE_OWNERS
CPACK_NUGET_<compName>_PACKAGE_OWNERS
@@ -92,8 +94,8 @@ List of CPack NuGet generator specific variables:
on nuget.org_. This is often the same list as in authors,
and is ignored when uploading the package to nuget.org_.
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_HOMEPAGE_URL
CPACK_NUGET_<compName>_PACKAGE_HOMEPAGE_URL
@@ -101,8 +103,8 @@ List of CPack NuGet generator specific variables:
An URL for the package's home page, often shown in UI displays as well
as nuget.org_.
* Mandatory : NO
* Default : :variable:`CPACK_PACKAGE_HOMEPAGE_URL`
:Mandatory: No
:Default: :variable:`CPACK_PACKAGE_HOMEPAGE_URL`
.. variable:: CPACK_NUGET_PACKAGE_LICENSEURL
CPACK_NUGET_<compName>_PACKAGE_LICENSEURL
@@ -116,8 +118,8 @@ List of CPack NuGet generator specific variables:
An URL for the package's license, often shown in UI displays as well
as on nuget.org_.
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION
CPACK_NUGET_<compName>_PACKAGE_LICENSE_EXPRESSION
@@ -131,24 +133,24 @@ List of CPack NuGet generator specific variables:
``MIT OR BSD-3-Clause``. See the `SPDX specification`_ for guidance
on forming complex license expressions.
If ``CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME`` is specified,
``CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION`` is ignored.
If :variable:`CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME` is specified,
:variable:`!CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION` is ignored.
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME
CPACK_NUGET_<compName>_PACKAGE_LICENSE_FILE_NAME
The package's license file in :file:`.txt` or :file:`.md` format.
If ``CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME`` is specified,
``CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION`` is ignored.
If :variable:`!CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME` is specified,
:variable:`!CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION` is ignored.
.. versionadded:: 3.20
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_ICONURL
CPACK_NUGET_<compName>_PACKAGE_ICONURL
@@ -159,16 +161,16 @@ List of CPack NuGet generator specific variables:
An URL for a 64x64 image with transparency background to use as the
icon for the package in UI display.
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_REQUIRE_LICENSE_ACCEPTANCE
When set to a true value, the user will be prompted to accept the license
before installing the package.
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_ICON
CPACK_NUGET_<compName>_PACKAGE_ICON
@@ -178,8 +180,8 @@ List of CPack NuGet generator specific variables:
The filename of a 64x64 image with transparency background to use as the
icon for the package in UI display.
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_DESCRIPTION_SUMMARY
CPACK_NUGET_<compName>_PACKAGE_DESCRIPTION_SUMMARY
@@ -187,8 +189,8 @@ List of CPack NuGet generator specific variables:
A short description of the package for UI display. If omitted, a
truncated version of description is used.
* Mandatory : NO
* Default : :variable:`CPACK_PACKAGE_DESCRIPTION_SUMMARY`
:Mandatory: No
:Default: :variable:`CPACK_PACKAGE_DESCRIPTION_SUMMARY`
.. variable:: CPACK_NUGET_PACKAGE_RELEASE_NOTES
CPACK_NUGET_<compName>_PACKAGE_RELEASE_NOTES
@@ -197,16 +199,16 @@ List of CPack NuGet generator specific variables:
often used in UI like the Updates tab of the Visual Studio Package
Manager in place of the package description.
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_COPYRIGHT
CPACK_NUGET_<compName>_PACKAGE_COPYRIGHT
Copyright details for the package.
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_LANGUAGE
CPACK_NUGET_<compName>_PACKAGE_LANGUAGE
@@ -215,8 +217,8 @@ List of CPack NuGet generator specific variables:
Locale specifier for the package, for example ``en_CA``.
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_TAGS
CPACK_NUGET_<compName>_PACKAGE_TAGS
@@ -225,34 +227,33 @@ List of CPack NuGet generator specific variables:
package and aid discoverability of packages through search and
filtering.
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_DEPENDENCIES
CPACK_NUGET_<compName>_PACKAGE_DEPENDENCIES
A list of package dependencies.
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_DEPENDENCIES_<dependency>_VERSION
CPACK_NUGET_<compName>_PACKAGE_DEPENDENCIES_<dependency>_VERSION
A `version specification`_ for the particular dependency, where
``<dependency>`` is an item of the dependency list (see above)
transformed with ``MAKE_C_IDENTIFIER`` function of :command:`string`
command.
transformed with :command:`string(MAKE_C_IDENTIFIER)` command.
* Mandatory : NO
* Default : -
:Mandatory: No
:Default: None
.. variable:: CPACK_NUGET_PACKAGE_DEBUG
Enable debug messages while executing CPack NuGet generator.
* Mandatory : NO
* Default : OFF
:Mandatory: No
:Default: ``OFF``
.. _nuget.org: https://www.nuget.org