| |
@@ -671,13 +671,28 @@
|
| |
|
| |
== Manpages
|
| |
|
| |
- As man pages are the traditional method of getting help on a Unix system, packages SHOULD contain them for all executables. If some man pages are absent, packagers SHOULD work with upstream to add them. It is also occasionally possible to find pages created by other distributions, or to use the output of the help2man program; those are often useful as a starting point. When installing man pages, note that they should be installed uncompressed as the build system will compress them as needed. The compression method may change, so it is important to reference the pages in the %files section with a pattern that takes this into account:
|
| |
+ As man pages are the traditional method of getting help on a Unix system,
|
| |
+ packages SHOULD contain them for all executables.
|
| |
+ If some man pages are absent,
|
| |
+ packagers SHOULD work with upstream to add them.
|
| |
+ It is also occasionally possible to find pages created by other distributions,
|
| |
+ or to use the output of the `+help2man+` program;
|
| |
+ those are often useful as a starting point.
|
| |
+ When installing man pages,
|
| |
+ note that RPM will re-compress them into its preferred format.
|
| |
+ So the `+%files+` section MUST reference manpages
|
| |
+ with a pattern that takes this into account:
|
| |
|
| |
....
|
| |
%files
|
| |
%{_mandir}/man1/foo.1*
|
| |
....
|
| |
|
| |
+ Note also that files installed in `+%{_mandir}+`
|
| |
+ are automatically marked by RPM as documentation.
|
| |
+ Thus it is not necessary to use `+%doc+`.
|
| |
+
|
| |
+
|
| |
[#compiler]
|
| |
== Compiler
|
| |
|
| |
tibbs
commented 4 years ago
Use SHOULD/MUST language throughout, and require that manpages be referenced by pattern.
(The first commit converts to semantic linebreaks; look at the following commits to see the actual changes).