FAQ Search Today's Posts Mark Forums Read
» Video Reviews

» Linux Archive

Linux-archive is a website aiming to archive linux email lists and to make them easily accessible for linux users/developers.


» Sponsor

» Partners

» Sponsor

Go Back   Linux Archive > Redhat > Fedora Packaging

 
 
LinkBack Thread Tools
 
Old 08-05-2010, 07:04 PM
Jonathan Dieter
 
Default New autogenerated documentation guideline proposal

I'm proposing a new guideline, that autogenerated documentation must be
a reasonable size. The reason for this guideline is that there are a
number of packages in the repository with automatically generated
documentation that is *far* bigger than the package itself.

Some examples:
antlr3 - src rpm size: 1.5MB - antlr3-C-doc rpm size: 56MB
cloudy - src rpm size: 23.0MB - cloudy-devel-doc rpm size: 110MB
kdelibs - src rpm size: 13.9MB - kdelibs-apidocs rpm size: 283MB
mrpt - src rpm size: 34.7MB - mrpt-doc rpm size: 252MB
xrootd - src rpm size: 1.7MB - xrootd-doc rpm size: 104MB

and, my all-time favorite (which sparked this whole thing):
root - src rpm size: 27.8MB - root-doc rpm size: 687MB

This isn't only a size problem. These packages also tend to have loads
of small files (root-doc has over 20,000), all of which end up in
filelists.xml, which then get processed by yum when it needs complete
filelists.

The proposed guideline is at the bottom of the "Queued but unowned"
table at https://fedoraproject.org/wiki/PackagingDrafts/DraftsTodo.

I'd love it if it could be discussed and possibly voted on at the next
meeting.

Jonathan
--
packaging mailing list
packaging@lists.fedoraproject.org
https://admin.fedoraproject.org/mailman/listinfo/packaging
 
Old 08-06-2010, 03:21 AM
Chen Lei
 
Default New autogenerated documentation guideline proposal

2010/8/6 seth vidal <skvidal@fedoraproject.org>:
> On Thu, 2010-08-05 at 21:13 -0400, Braden McDaniel wrote:
>> > * These packages also tend to have loads
>> > of small files (root-doc has over 20,000), all of which end up in
>> > filelists.xml, which then get processed by yum when it needs complete
>> > filelists.
>>
>> To the extent that this sort of thing is a real *general* problem, it
>> needs to be solved on the yum side.
>
> Agreed. It may become a target feature for f15- but it will involve
> changing the format of the repodata and that will be invasive.
>
>
> -sv

At least, we should not ship apidocs for normally desktop program(e.g.
gedit) and not ship duplicate format docs(e.g. shipping html pdf doc
in the same package), personally I like html docs better than doc/pdf.

I suggest to disscuss extreme big auto-generated apidocs(size > 100M)
rpm case by case, it'll be better to determine whether shipping it or
not by FESCo. I think only popular libraries are worth to ship a big
-doc subpackage, other library packages should not enable generate big
doc subpackage by default, user who really need those docs can
generate -doc subpackage by running 'rpmbuild -bb with...'.

Regards,
Chen Lei
--
packaging mailing list
packaging@lists.fedoraproject.org
https://admin.fedoraproject.org/mailman/listinfo/packaging
 

Thread Tools




All times are GMT. The time now is 04:38 PM.

VBulletin, Copyright ©2000 - 2014, Jelsoft Enterprises Ltd.
Content Relevant URLs by vBSEO ©2007, Crawlability, Inc.
Copyright 2007 - 2008, www.linux-archive.org