diff options
| author | Alex Turbov <i.zaufi@gmail.com> | 2024-06-17 13:46:10 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2024-06-17 15:47:35 (GMT) |
| commit | a6a8212ba2084184b9ff5d98a022f1c4c9e0c661 (patch) | |
| tree | 78d428a3398c59a125d9fa4210534ca677527ba6 /Help | |
| parent | 039bf0f3f3b1f47a9a5750aba19c33dec5e15fde (diff) | |
| download | CMake-a6a8212ba2084184b9ff5d98a022f1c4c9e0c661.zip CMake-a6a8212ba2084184b9ff5d98a022f1c4c9e0c661.tar.gz CMake-a6a8212ba2084184b9ff5d98a022f1c4c9e0c661.tar.bz2 | |
Help: CPack/NuGet add description to the added variables
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/cpack_gen/nuget.rst | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/Help/cpack_gen/nuget.rst b/Help/cpack_gen/nuget.rst index e6ff9cc..3773a1d 100644 --- a/Help/cpack_gen/nuget.rst +++ b/Help/cpack_gen/nuget.rst @@ -180,6 +180,17 @@ Optional metadata variables :Mandatory: No :Default: None +.. variable:: CPACK_NUGET_PACKAGE_README + CPACK_NUGET_<compName>_PACKAGE_README + + .. versionadded:: 3.30 + + The package path relative to the root of the package to a readme file. + Supported file formats include only Markdown (``*.md``). + + :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 @@ -239,6 +250,50 @@ Optional metadata variables :Mandatory: No :Default: None +.. variable:: CPACK_NUGET_PACKAGE_REPOSITORY_URL + CPACK_NUGET_<compName>_REPOSITORY_URL + + .. versionadded:: 3.30 + + Repository metadata allows you to map the ``*.nupkg`` to the repository + that built it. This should be a publicly available URL that can be invoked + directly by a version control software. It should not be an HTML page as + this is meant for the computer. + + :Mandatory: No + :Default: None + +.. variable:: CPACK_NUGET_PACKAGE_REPOSITORY_TYPE + CPACK_NUGET_<compName>_REPOSITORY_TYPE + + .. versionadded:: 3.30 + + A type of the VCS repository. When uploading a package to nuget.org_, the + type is limited to 100 characters. + + :Mandatory: Yes, if repository URL has been specified + :Default: None + +.. variable:: CPACK_NUGET_PACKAGE_REPOSITORY_BRANCH + CPACK_NUGET_<compName>_REPOSITORY_BRANCH + + .. versionadded:: 3.30 + + A VSC branch name to build the package. + + :Mandatory: No + :Default: None + +.. variable:: CPACK_NUGET_PACKAGE_REPOSITORY_COMMIT + CPACK_NUGET_<compName>_REPOSITORY_COMMIT + + .. versionadded:: 3.30 + + A SHA-1 hash of the commit to build the package. + + :Mandatory: No + :Default: None + .. variable:: CPACK_NUGET_PACKAGE_TITLE CPACK_NUGET_<compName>_PACKAGE_TITLE |