Changes between Version 51 and Version 52 of RpmHowToPackagers
- Timestamp:
- Feb 3, 2017, 12:16:13 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
RpmHowToPackagers
v51 v52 339 339 == Creating doc packages == 340 340 341 A lot of software comes with various types of documentation. User-level documentation (such as manuals in MAN and INFO formats) is usually installed with the main package as it should be always available once the software is installed. However, many software packages also come with the development libraries (in a sub-package called `PACKAGE-devel` ) accompanied by the documentation for developers. This documentation may occupy quite a lot of space on disk (several or even several dozen MB) when installed and unpacked. Given that it's usually more convenient to read it online, it makes little sense to have it installed each time when `PACKAGE-devel` is installed.341 A lot of software comes with various types of documentation. User-level documentation (such as manuals in MAN and INFO formats) is usually installed with the main package as it should be always available once the software is installed. However, many software packages also come with the development libraries (in a sub-package called `PACKAGE-devel` where PACKAGE is the main .spec package name) accompanied by the documentation for developers. This documentation may occupy quite a lot of space on disk (several or even several dozen MB) when installed and unpacked. Given that it's usually more convenient to read it online, it makes little sense to have it installed each time when `PACKAGE-devel` is installed. 342 342 343 343 Some packages already separate the developer's documentation from the development sub-package by putting it to a separate package `PACKAGE-devel-doc` but there is a plenty of them that still put everything in `PACKAGE-devel`. A .spec file for such a packages should be altered to separate the documentation from development libraries and tools. Here is a template for the respective part of the .spec file: … … 369 369 Note that in some cases user-level documentation may also be quite bulky (especially when it contains a lot of HTML files with pictures, big PDF files, etc). In such cases it may make sense to put it to a separate package, named `PACKAGE-doc` (`%package doc` in terms of the .spec file) similarly to the template shown above. A rule of thumb is that brief documentation (MAN, INFO) should be always installed with the main package and extended documentation, if it's several dozen MB or more, should go to a `doc` sub-package. 370 370 371 == Generating debug packages ==372 373 RPM can automatically extract debug info from the EXEs and DLLs built by the .spec file and put this info into a separate sub-package named `PACKAGE-debug `where PACKAGE is the main .spec package name. In order to do that, the following directive needs to be added to the .spec file (usually, after all package and sub-package definitions and before the `%prep` section, surrounded by empty lines):371 == Generating debug info packages == 372 373 RPM can automatically extract debug info from the EXEs and DLLs built by the .spec file and put this info into a separate sub-package named `PACKAGE-debuginfo` (formally `PACKAGE-debug`) where PACKAGE is the main .spec package name. In order to do that, the following directive needs to be added to the .spec file (usually, after all package and sub-package definitions and before the `%prep` section, surrounded by empty lines): 374 374 {{{ 375 375 %debug_package