Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!

Bug 350052

Summary: Ebuild request app-doc/opengl-manpages
Product: Gentoo Linux Reporter: Samuel Bauer <samuel.bauer>
Component: New packagesAssignee: Default Assignee for New Packages <maintainer-wanted>
Status: CONFIRMED ---    
Severity: normal CC: dschridde+gentoobugs, moreilcon
Priority: High    
Version: unspecified   
Hardware: All   
OS: Linux   
URL: http://www.opengl.org/wiki/Getting_started/XML_Toolchain_and_Man_Pages
Whiteboard:
Package list:
Runtime testing required: ---
Attachments: opengl manpages from khronos CVS
opengl manpages from khronos CVS
metadata file for opengl-manpages
opengl-manpages with html ouptut support
Ressource to fix the author for groff output
opengl-manpages-4.9999.ebuild
opengl-manpages-4.9999.ebuild
also includes manvol fix
opengl-manpages-4.9999.ebuild

Description Samuel Bauer 2010-12-29 16:51:32 UTC
The opengl manpages are not in Gentoo since the old package based on SGI opengl man pages appear to be deprecated.
The opengl.org website allow to fetch man pages as XML format from CVS. Yet, they didn't explained how to build the man pages to man format (only explained for html output). I added a procedure to their website and packaged an ebuild for gentoo.
Lot of user like to have the man-pages from the command line rather than in one ebuild.

Reproducible: Always

Steps to Reproduce:




Bug already known (#120375), but closed.

This ebuild depends on non official ebuilds like

http://bugs.gentoo.org/show_bug.cgi?id=194501
http://bugs.gentoo.org/show_bug.cgi?id=349033

This ebuild is a little better than the previous submitted
Comment 1 Samuel Bauer 2010-12-29 16:54:09 UTC
Created attachment 258372 [details]
opengl manpages from khronos CVS

If all flags unset then this ebuild installs nothing.
Missing pdf output format
Comment 2 Samuel Bauer 2010-12-29 21:39:44 UTC
Created attachment 258396 [details]
opengl manpages from khronos CVS
Comment 3 Samuel Bauer 2010-12-29 21:41:13 UTC
Created attachment 258398 [details]
metadata file for opengl-manpages
Comment 4 Samuel Bauer 2010-12-30 17:31:38 UTC
As suggested in the metadata.xml attachement, I can maintain this package.
Anyway when I'll see how to generate pdf output I'll add support for this in the ebuild and enrich the opengl wiki related page.
But this ebuild depends on two ebuild not in the portage tree yet.
app-text/docbook-mathml-dtd, I submitted this one but don't feel like I can maintain it as my knowledge for docbook is quite null.
app-text/mathml-xml-dtd which was submitted by another dude but is not having maintainer.

Those ebuild can be found here yet:
http://bugs.gentoo.org/show_bug.cgi?id=194501
http://bugs.gentoo.org/show_bug.cgi?id=349033

So I don't know how to become maintainer of an ebuild whose have unmaintained dependencies.
Comment 5 Samuel Bauer 2010-12-30 17:40:09 UTC
Also this ebuild was previously proposed from SGI manpages, which are unmaintained

http://bugs.gentoo.org/show_bug.cgi?id=120375

They suggest in this bug to make an ebuild with the khronos ( opengl.org ) CVS server. This bug was closed and none reply when I submitted a fix, this why I opened a new bug.


P.S.: .s/ebuild/web browser/ Lot of user like to have the man-pages from the command line rather than in one ebuild. :)
Comment 6 Samuel Bauer 2011-04-28 20:08:25 UTC
Created attachment 271489 [details]
opengl-manpages with html ouptut support
Comment 7 Samuel Bauer 2011-04-28 20:10:26 UTC
Created attachment 271491 [details]
Ressource to fix the author for groff output
Comment 8 Dennis Schridde 2011-08-26 18:46:24 UTC
I fully support this request. Would it be possible to proxy maintain it? Otherwise: Whiteboard+=sunrise-suggested
Comment 9 Samuel Bauer 2011-08-28 17:03:41 UTC
(In reply to comment #8)
> I fully support this request. Would it be possible to proxy maintain it?

It would be possible, as the documentation is a CVS repository, proxy maintain it shouldn't be that much work. But for the dependencies (mathml-xml-dtd, docbook-mathml-dtd), I dare not to be. I'm not a docbook specialist nor than a mathml specification afficionados.

To avoid dependencies, I can try to maintain a snapshot of my "locally generated documentation". I think if I ask the repository admin to mail me whenever there is a commit, it won't be to much pain for him.

(In reply to comment #8)
> Otherwise: Whiteboard+=sunrise-suggested

I already tried to commit this ebuild on sunrise but for some obscure reasons (as far as I remember) the XML team refused the mathml-xml-dtd and docbook-mathml-dtd ebuilds. Those ebuild are dependencies for the former one.

All those ebuild have already been reviewed on the sunrise irc channel, so they are supposed to be "standard".
Comment 10 Dennis Schridde 2011-08-29 15:06:01 UTC
Created attachment 285015 [details]
opengl-manpages-4.9999.ebuild

Attached ebuild builds the OpenGL 2,3,4 manpages (name it opengl-manpages-{2,3,4}.9999.ebuild to build the respective versions). It depends on https://bugs.gentoo.org/attachment.cgi?id=271491 (files/fix-author-manual.xsl) and attachment #258398 [details] (metadata.xml).

This ebuild presents a minor improvement over the previously attached ebuilds:
* It can build docs for OpenGL 2,3,4
* It moves the fix using "fix-author-manual.xsl" into src_prepare, since it seems more like a sed than regular building
* Makes repoman happy
* Apart from that there are only some minor string changes and removal of some unimportant/obvious messages

Comments and improvements welcome.
Comment 11 Samuel Bauer 2011-08-30 09:26:16 UTC
When you do something more it would be nice to edit the khronos wiki.
When doing this all the user will have an easy access to documentation.

http://www.opengl.org/wiki/Getting_started/XML_Toolchain_and_Man_Pages
The section to edit is: "Output manual pages to man format" (even the section title is weird, it would better be: output to groff format)
Comment 12 Dennis Schridde 2011-09-01 13:11:54 UTC
Created attachment 285237 [details]
opengl-manpages-4.9999.ebuild

The previously attached ebuild had a bug where the check for major_version=2 was wrong, resulting in a broken ESVN_REPO_URI for this version.
Comment 13 moreilcon 2011-09-15 17:43:02 UTC
Created attachment 286563 [details]
also includes manvol fix

due `doman` limitations manual pages installed into /usr/share/man/man3,
on contrary, internal man references use man3G prefix (see for example glUniform4i)

attached xslt includes `<manvolnum>3G</manvolnum>` to `<manvolnum>3</manvolnum>` substitution
Comment 14 moreilcon 2011-09-15 17:56:17 UTC
Created attachment 286565 [details]
opengl-manpages-4.9999.ebuild

updated ebuild version
Comment 15 Samuel Bauer 2013-08-27 02:07:03 UTC
Initial major version checking is now unuseful as svn directory for opengl2 manpages is now: https://cvs.khronos.org/svn/repos/ogl/trunk/ecosystem/public/sdk/docs/man2/

GLSL manpages could be compiled using the current ebuild. But there's some other fixes to apply.

To insure different version of the glManpages maybe could we pretend gl3 and gl4 for version 3 and 4 (Else ebuilds should be mutually exclusive).