Gentoo Archives: gentoo-dev

From: "Haelwenn (lanodan) Monnier" <contact@×××××××××.me>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] [RFC] New QA policy: Packages must not disable installing manpages via USE flags
Date: Wed, 17 Jul 2019 13:43:07
Message-Id: 20190717134259.GH22170@cloudsdale.the-delta.net.eu.org
In Reply to: [gentoo-dev] [RFC] New QA policy: Packages must not disable installing manpages via USE flags by "Michał Górny"
1 [2019-07-17 15:25:10+0200] Michał Górny:
2 > The QA team would like to introduce the following policy:
3 >
4 > """
5 > Packages must not disable installing manpages via USE flags (e.g.
6 > USE=man or USE=doc). If upstream does not ship prebuilt manpages
7 > and building them requires additional dependencies, the maintainer
8 > should build them and ship along with the package.
9 > """
10
11 Should this be for any dependency? For example wlroots, sway, … are
12 using scdoc to transform a form of markdown to manpages, and the
13 resulting program is very small.
14
15 $ qsize scdoc
16 app-text/scdoc-1.9.3-r1: 5 files, 12 non-files, 59.9K
17
18 So in my opinion if the dependency is probably smaller than bundling
19 the files the dependency should be used.
20
21 > Rationale:
22 >
23 > Manpages are the basic form of user documentation on Gentoo Linux. Not
24 > installing them is harmful to our users. On the other hand, requiring
25 > additional dependencies is inconvenient. Therefore, packaging prebuilt
26 > manpages (whenever upstream doesn't do that already) is a good
27 > compromise that provides user with documentation without additional
28 > dependencies.
29
30 I would fully support that as in my opinion all ebuilds should provide
31 at least usage documentation though manpages and/or via the
32 non-standard -h / --help.

Replies