E. Liddell wrote:

On Fri, 8 Jan 2021 16:31:44 +0100 Slávek Banko via tde-team-gentoo <team-gentoo(a)trinitydesktop.org&gt; wrote:

...

Hi Gentoo team,

when revising TDE/tdegames#11, which adds conditions so that only the documentation for applications that are built is installed, I realized that I don't know how you build the documentation for the core packages and whether this will cause a problem for your packaging?

A simple question with a complex answer.

Chris decided to deviate from standard procedure and place the documentation in separate ebuilds, such as trinity-base/tdegames-doc . Presumably this was easier for him at the time, because the documentation was monolithic. Splitting the documentation may make this stop-gap a little awkward to work with, but I think we can figure something out.

Standard Gentoo procedure would be to have each package install only its own documentation, controlled by a "doc" USE flag. We may want to rework things in that direction.

...

Please can you look at it? See https://mirror.git.trinitydesktop.org/gitea/TDE/tdegames/pulls/11

The idea seems good to me and I assume that it could be used for other core modules in the same way.

The only thing you need to keep in mind is that Gentoo users prefer to avoid having unwanted documentation built automagically. So having a WITH_DOCS flag somewhere that can be turned off to kill all documentation would be helpful.

(If there's no way to turn off the documentation, I expect we'll grin and bear it, though. It wouldn't be the first time some package had a feature that should be optional but is impossible to turn off.)

E. Liddell

I guess the way Greg prepared it seems good for you, too. There is a BUILD_DOC option that allows you to turn off all documentation. And if documentation building is turned on, then by adding conditions according to individual applications, only the documentation for the applications that are being built is generated and installed there.

So it seems to be a good step forward so that instead of a monolithic documentation package, the documentation can be installed here along with the applications to which it belongs.

Cheers