On Thu, Aug 05, 2010 at 03:19:46PM -0400, Orcan Ogetbil wrote: > On Thu, Aug 5, 2010 at 3:11 PM, Jonathan Dieter wrote: > > On Thu, 2010-08-05 at 14:24 -0400, Toshio Kuratomi wrote: > >> I don't think we could just say don't package documentation that's > >> ridiculously large but perhaps we could make some sort of guideline about > >> not duplicating formats on extra large docs. Is the case with root-docs > >> (and/or kdelibs-apidocs) that we have docs in text + html + tex + pdf > >> + your_format_here? > > > > The problem is that, at least for root-doc (not sure about > > kdelibs-apidocs), it's all html. > > > > Please note that I'm not saying "don't package documentation that's > > ridiculously large", but rather, "don't package automatically generated > > documentation that's ridiculously large". > > > > Is it generated by doxygen? In that case, doxy files usually have > options to disable building certain portions of the documentation. > > For example, when building a library package, we don't want the full > source documentation. We only want the documentation of the API the > library is exposing. > Yaah -- so if it's useful documentation, then I'd be against creating a rule that bans it. The next question would be whether it's useful or not.... Public vs private certainly sounds like one thing to look at. However, some libraries might want to ship information about their private interfaces for people who want to help hack on the library so it's not a 100% thing that I'd want to enforce with a Guideline.... Perhaps in these two specific cases it would be best to open bugs for the maintainers to look at whether some of the documentation in here isn't considered useful and could be left out. -Toshio
Attachment:
pgp5KwyNYuOd5.pgp
Description: PGP signature
-- devel mailing list devel@xxxxxxxxxxxxxxxxxxxxxxx https://admin.fedoraproject.org/mailman/listinfo/devel
