[Fedora-packaging] Package content question

Richard Fearn richardfearn at gmail.com
Thu Dec 20 22:45:47 UTC 2007


Thanks for your help Dominik.

> They may be included as %doc or in a separate subpackage if their size
> makes up a significant portion of the main package.

I have a few more questions regarding the documentation. The upstream
developer of php-pdb has written his documentation as PHP scripts, for
two reasons:

1. there are some basic template functions in each page
(StandardHeader, StandardFooter, etc.)
2. some of the doc files are actually examples - which use the php-pdb
library to generate database files.

Is this a good reason for not including *any* of the documentation
with my php-pdb package? If the files just get placed into
/usr/share/doc/php-pdb-1.3.4 then they can't be viewed unless Apache
is serving the files somehow. Or should I be doing more to make sure
they are readable? (Such as converting the PHP scripts to static HTML
files?) Are there any other packages that supply documentation in the
form of PHP scripts as opposed to text or HTML files?

The docs also include a .tar.gz containing a patched version of the
php-pdb library, used to add export functionality to another program.
It's not really an example - it's an alternative version of php-pdb to
be used with another program. I intend to remove it for the php-pdb
package - is that the right thing to do?

Finally, there's another .tar.gz included in the docs, which contains
a sample app that is also part of the docs - but I think I'm going
have to remove the unpacked app (and remove links and references to it
in the remaining doc files), because it can't run from inside
/usr/share/doc (it would need write access to
/usr/share/doc/php-pdb-1.3.4/samples/spade). Is it OK to leave the
.tar.gz there as a sample app, though?

Thanks.

Richard Fearn




More information about the Fedora-packaging mailing list