[Fedora-packaging] Should {NEWS, CHANGELOG, README, etc} go into main package or -doc subpackage?

Vít Ondruch vondruch at redhat.com
Mon Sep 10 14:12:29 UTC 2012


Dne 10.9.2012 16:04, Michael Schwendt napsal(a):
> On Mon, 10 Sep 2012 15:46:18 +0200, Vít Ondruch wrote:
>
>> Hi,
>>
>> Can somebody clarify where should go the files mentioned in $SUBJECT if
>> the package provides a -doc subpackage? It is obvious that the LICENSE
>> file must go into the main package, but what about the others? There are
>> packages, which has the $SUBJECT files in main package, but I think they
>> should go into -doc subpackage. What else wold be the -doc subpackage
>> purpose then?
>>
>> BTW it would be nice if the guidelines could be clarified regarding this
>> issue.
> A -doc subpackage is justified to split off _huge_ documentation in order
> to reduce the size of an installation, spin, or -devel pkg depchain.
> The purpose of -doc packages is not to strip off all documentation of
> packages.
>
> Small doc files, such as those you mention (also NEWS, AUTHORS), may be nice
> to have available always together with the software - whereas large books or
> generated API HTML trees for developers may be considered more optional.
>

Nicely put, this should definitely go into guidelines.

Vit


More information about the packaging mailing list