MantisBT - CMake
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0013899CMakeDocumentationpublic2013-02-07 19:232016-06-10 14:21
ReporterJonathan M Davis 
Assigned ToDomen Vrankar 
PrioritynormalSeverityminorReproducibilityalways
StatusclosedResolutionfixed 
PlatformOSOS Version
Product VersionCMake 2.8.10.2 
Target VersionFixed in VersionCMake 3.5 
Summary0013899: Documentation for RPM CPack generator is missing a number of the variables that it supports
DescriptionI don't know if this report is entirely appropriate, since it relates to the wiki rather than the official documentation, but that's the only documentation for the CPack RPM generator that I'm aware of. In any case, the page http://www.cmake.org/Wiki/CMake:CPackPackageGenerators#RPM_.28Unix_Only.29 [^] lists the RPM-specific variables that CPack's RPM generator supports, and it's missing several of them. In particular, these variables are missing

CPACK_RPM_PACKAGE_URL
CPACK_RPM_PACKAGE_SUGGESTS
CPACK_RPM_PACKAGE_OBSOLETES
CPACK_RPM_PACKAGE_PREFIX
CPACK_RPM_PACKAGE_CONFLICTS
CPACK_RPM_PACKAGE_AUTOPROV
CPACK_RPM_PACKAGE_AUTOREQ
CPACK_RPM_PACKAGE_AUTOREQPROV

They need to be documented. It took me quite a while to figure out how to figure out that CPACK_RPM_PACKAGE_AUTOREQPROV even existed, let alone how to set it (bug# 13898 made that harder than it should have been). You shouldn't need to read CPackRPM.cmake to figure out how to use CPack's RPM generator.
Steps To Reproduce
Additional Information
TagsNo tags attached.
Relationships
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2013-02-07 19:23Jonathan M DavisNew Issue
2013-02-08 03:33Eric NOULARDAssigned To => Eric NOULARD
2013-02-08 03:33Eric NOULARDStatusnew => assigned
2013-02-08 03:46Eric NOULARDNote Added: 0032218
2016-05-12 17:13Domen VrankarAssigned ToEric NOULARD => Domen Vrankar
2016-05-17 18:52Domen VrankarNote Added: 0041070
2016-05-17 18:52Domen VrankarStatusassigned => resolved
2016-05-17 18:52Domen VrankarFixed in Version => CMake 3.5
2016-05-17 18:52Domen VrankarResolutionopen => fixed
2016-06-10 14:21Kitware RobotNote Added: 0041169
2016-06-10 14:21Kitware RobotStatusresolved => closed

Notes
(0032218)
Eric NOULARD   
2013-02-08 03:46   
Hi Jonathan,

The Wiki is out-dated you are right.
Wiki is nice w.r.t. display and layout but it is painful to maintain in sync with the actual source code.

I decided to put more effort into "builtin" documentation.
So that you should find hopefully up-to-date doc using:

cpack --help-variable[-list]
cpack --help-command[-list]

The documentation is [automatically] extracted from the concerned CPack module.
For RPM it is in CPackRPM.cmake.
For DEB in CPackDEB.cmake
etc...

> You shouldn't need to read CPackRPM.cmake to figure out how to use CPack's RPM generator.

Right, we are "almost" there because on can get access to each macro/variable doc.

and/or you can get the whole "module doc" using:
cmake --help-module CPackRPM

(there is no cpack --help-module yet...)

In the end not all CPACK_RPM_PACKAGE variables are documented, we still lack:
CPACK_RPM_PACKAGE_PREFIX
CPACK_RPM_PACKAGE_CONFLICTS
CPACK_RPM_PACKAGE_AUTOPROV
CPACK_RPM_PACKAGE_AUTOREQ
CPACK_RPM_PACKAGE_AUTOREQPROV

But documentation patches are welcome as well.
(0041070)
Domen Vrankar   
2016-05-17 18:52   
CPackRPM documentation that comes with each CMake release now contains the description of all the supported variables:

https://cmake.org/cmake/help/v3.5/module/CPackRPM.html [^]
(0041169)
Kitware Robot   
2016-06-10 14:21   
This issue tracker is no longer used. Further discussion of this issue may take place in the current CMake Issues page linked in the banner at the top of this page.