summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorAlex Turbov <i.zaufi@gmail.com>2024-06-17 13:07:06 (GMT)
committerBrad King <brad.king@kitware.com>2024-06-17 15:47:35 (GMT)
commit4e11de312b983f3eccf85d37776aa3dc30e54158 (patch)
treea202969f70bb9321c3eeb93b327c737f1b4d38a3 /Help
parent4556f9151793c643eefc7165e23bb8d3ef6b8601 (diff)
downloadCMake-4e11de312b983f3eccf85d37776aa3dc30e54158.zip
CMake-4e11de312b983f3eccf85d37776aa3dc30e54158.tar.gz
CMake-4e11de312b983f3eccf85d37776aa3dc30e54158.tar.bz2
Help: Reorder variables as they mentioned in the official spec
Also, group 'em into sub-sub-sections (same as in the upstream doc). See also, https://learn.microsoft.com/en-us/nuget/reference/nuspec
Diffstat (limited to 'Help')
-rw-r--r--Help/cpack_gen/nuget.rst90
1 files changed, 51 insertions, 39 deletions
diff --git a/Help/cpack_gen/nuget.rst b/Help/cpack_gen/nuget.rst
index e25364f..8c94959 100644
--- a/Help/cpack_gen/nuget.rst
+++ b/Help/cpack_gen/nuget.rst
@@ -34,6 +34,17 @@ List of CPack NuGet generator specific variables:
:Mandatory: No
:Default: ``OFF``
+.. variable:: CPACK_NUGET_PACKAGE_DEBUG
+
+ Enable debug messages while executing CPack NuGet generator.
+
+ :Mandatory: No
+ :Default: ``OFF``
+
+
+Required metadata variables
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
.. variable:: CPACK_NUGET_PACKAGE_NAME
CPACK_NUGET_<compName>_PACKAGE_NAME
@@ -74,18 +85,9 @@ List of CPack NuGet generator specific variables:
:Mandatory: Yes
:Default: :variable:`CPACK_PACKAGE_VENDOR`
-.. variable:: CPACK_NUGET_PACKAGE_TITLE
- CPACK_NUGET_<compName>_PACKAGE_TITLE
- A human-friendly title of the package, typically used in UI displays
- as on nuget.org_ and the Package Manager in Visual Studio. If not
- specified, the package ID is used.
-
- :Mandatory: No
- :Default:
-
- - :variable:`CPACK_COMPONENT_<compName>_DISPLAY_NAME`,
- - :variable:`!CPACK_COMPONENT_GROUP_<groupName>_DISPLAY_NAME`
+Optional metadata variables
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. variable:: CPACK_NUGET_PACKAGE_OWNERS
CPACK_NUGET_<compName>_PACKAGE_OWNERS
@@ -121,6 +123,19 @@ List of CPack NuGet generator specific variables:
: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 :variable:`!CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME` is specified,
+ :variable:`!CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION` is ignored.
+
+ .. versionadded:: 3.20
+
+ :Mandatory: No
+ :Default: None
+
.. variable:: CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION
CPACK_NUGET_<compName>_PACKAGE_LICENSE_EXPRESSION
@@ -139,19 +154,6 @@ List of CPack NuGet generator specific variables:
: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 :variable:`!CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME` is specified,
- :variable:`!CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION` is ignored.
-
- .. versionadded:: 3.20
-
- :Mandatory: No
- :Default: None
-
.. variable:: CPACK_NUGET_PACKAGE_ICONURL
CPACK_NUGET_<compName>_PACKAGE_ICONURL
@@ -164,14 +166,6 @@ List of CPack NuGet generator specific variables:
: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: None
-
.. variable:: CPACK_NUGET_PACKAGE_ICON
CPACK_NUGET_<compName>_PACKAGE_ICON
@@ -183,6 +177,14 @@ List of CPack NuGet generator specific variables:
: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: None
+
.. variable:: CPACK_NUGET_PACKAGE_DESCRIPTION_SUMMARY
CPACK_NUGET_<compName>_PACKAGE_DESCRIPTION_SUMMARY
@@ -230,6 +232,23 @@ List of CPack NuGet generator specific variables:
:Mandatory: No
:Default: None
+.. variable:: CPACK_NUGET_PACKAGE_TITLE
+ CPACK_NUGET_<compName>_PACKAGE_TITLE
+
+ A human-friendly title of the package, typically used in UI displays
+ as on nuget.org_ and the Package Manager in Visual Studio. If not
+ specified, the package ID is used.
+
+ :Mandatory: No
+ :Default:
+
+ - :variable:`CPACK_COMPONENT_<compName>_DISPLAY_NAME`,
+ - :variable:`!CPACK_COMPONENT_GROUP_<groupName>_DISPLAY_NAME`
+
+
+Dependencies specification
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
.. variable:: CPACK_NUGET_PACKAGE_DEPENDENCIES
CPACK_NUGET_<compName>_PACKAGE_DEPENDENCIES
@@ -284,13 +303,6 @@ List of CPack NuGet generator specific variables:
:Mandatory: No
:Default: None
-.. variable:: CPACK_NUGET_PACKAGE_DEBUG
-
- Enable debug messages while executing CPack NuGet generator.
-
- :Mandatory: No
- :Default: ``OFF``
-
Example usage
^^^^^^^^^^^^^