Re: /usr/share/gtk-doc status
2011/2/21 80 karlthe...@gmail.com: Hi, i'm co-maintaining part of the gtkmm stack and a documentation location issue has been raised (https://bugzilla.redhat.com/show_bug.cgi?id=678981) By default, gtkmm-related packages put their documentation in /usr/share/doc, but for historical reason, fedora packages move them to /usr/share/gtk-doc. Since it's quite error-prone (you have to move documentation and fix devhelp index files), and not uniformized, if we don't have any mandatory rule to move documentation to /usr/share/gtk-doc (technically, gtkmm documentation is generated by doxygen and not gtk-doc), i'd like to stick to default location (/usr/share/doc). Other distro seems to use /usr/share/doc for gtkmm documentation. Either way, we need to fix all doc subpackages, but i'd like to gather your opinions before doing anything. I'm maintaining (sort of) libvtemm, which is also a part of mm stack. In this package I decided to keep docs in /usr/share/doc, but the only change I did is moving .devhelp2 file from /usr/share/devhelp/... to /usr/share/gtk-doc. For details, see libvtemm.spec [1]. [1] http://pkgs.fedoraproject.org/gitweb/?p=libvtemm.git;a=blob;f=libvtemm.spec#l58 best regards, H. Hope this helps, Krzesimir Nowak -- devel mailing list devel@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/devel -- devel mailing list devel@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/devel
Re: /usr/share/gtk-doc status
Le 21/02/2011 09:41, 80 a écrit : (you have to move documentation and fix devhelp index files), Not only package.devhelp, but also package.pc which is used to retrieve doc path by others packages. # pkg-config --variable=doxytagfile cairomm-1.0 /usr/share/doc/cairomm-1.0/reference/cairomm-1.0.tag # pkg-config --variable=htmlrefdir cairomm-1.0 /usr/share/doc/cairomm-1.0/reference/html Remi. -- devel mailing list devel@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/devel
Re: /usr/share/gtk-doc status
2011/2/21 Remi Collet fed...@famillecollet.com: Le 21/02/2011 09:41, 80 a écrit : (you have to move documentation and fix devhelp index files), Not only package.devhelp, but also package.pc which is used to retrieve doc path by others packages. # pkg-config --variable=doxytagfile cairomm-1.0 /usr/share/doc/cairomm-1.0/reference/cairomm-1.0.tag # pkg-config --variable=htmlrefdir cairomm-1.0 /usr/share/doc/cairomm-1.0/reference/html Remi. -- devel mailing list devel@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/devel -- devel mailing list devel@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/devel
Re: /usr/share/gtk-doc status
@krzesimir: thank you, if we settle to /usr/share/doc, then you should move devhelp index to /usr/share/devhelp/books. Another issue is that gtkmm doc subpackages should require base package documentation packages (for libvtemm, at least gtkmm24-doc, glibmm24-doc, libsigc++20-doc) so that hyperlinks are not broken. @remi: thank for reporting the original issue, that will be taken into account. H. -- devel mailing list devel@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/devel
Re: /usr/share/gtk-doc status
2011/2/21 80 karlthe...@gmail.com: @krzesimir: thank you, if we settle to /usr/share/doc, then you should move devhelp index to /usr/share/devhelp/books. I moved devhelp2 file to directory owned by gtk-doc because avoiding dependency on devhelp application seemed sensible to me - it is not necessary to read doxygen docs. Another issue is that gtkmm doc subpackages should require base package documentation packages (for libvtemm, at least gtkmm24-doc, glibmm24-doc, libsigc++20-doc) so that hyperlinks are not broken. I suppose that in such case those hyperlinks linked to library.gnome.org, but should be checked. H. -- devel mailing list devel@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/devel -- devel mailing list devel@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/devel
Re: /usr/share/gtk-doc status
2011/2/21 80 karlthe...@gmail.com: As for /usr/share/devhelp/books, since a similar issue raised by gtk-doc, guidelines should allow us now to own /usr/share/devhelp/books since devhelp is an optional functionality. http://fedoraproject.org/wiki/PackagingGuidelines#Conditional_dependencies The directory is owned by a package which is not required for your package to function best regards, H. I see, so I suppose that no moving/seding/whatnot should be done with documentation now. I'll try to fix it in my free time. -- devel mailing list devel@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/devel
Re: /usr/share/gtk-doc status
On Mon, Feb 21, 2011 at 10:18:38AM +0100, 80 wrote: @krzesimir: thank you, if we settle to /usr/share/doc, then you should move devhelp index to /usr/share/devhelp/books. One thing to note about /usr/share/doc is that files under there are automatically marked as %doc. Programs can't have a runtime dependency on those because someone could install with --nodoc to omit those files. So with the devhelp index -- if devhelp can tell that the documentation doesn't exist and then doesn't show the index entry, you're fine. If devhelp shows an entry for the documentation but yields an error when someone tries to use it, it's probably better not to use /usr/share/doc or otherwise mark the files as %doc. -Toshio pgpd7At7QYP3Y.pgp Description: PGP signature -- devel mailing list devel@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/devel
