i'm trying to play around with opengl and glut. especially i want to be able to read the man-pages for the glut callback functions without being online ;) but there aren't any man pages available for glut and even freeglut. Reproducible: Always Steps to Reproduce: 1. man glutSpecialFunc 2. 3. Actual Results: no man page available Expected Results: i should see the man page of glutSpecialFunc
I'd love to install freeglut man pages. Please, point me to where in the source they are and how to install them.
Created attachment 44564 [details] openglut-doc ebuild
Freeglut developers have confirmed that no documentation was provided with the freeglut package in man page format. Nevertheless, the OpenGlut project, based on freeglut, provides a single package dedicated to documentation and man pages. So here's my deal : - I propose to add a dependency towards openglut-doc in glut and freeglut ebuilds, if the `doc` USE flag is set. You will find attached to that post an ebuild for openglut-doc and revisions for glut and freeglut. - Moreover, I wanted to try openglut so I wrote an ebuild for it as well (attached). All of this stuff works on my box... just needs to be tested. Feel free to join me if you see more elegant improvements. ++ julien PS : I think openglut-doc better fits in the `dev-util` section than in the `media-libs`. What's your opinion donnie ?
Created attachment 44565 [details] Freeglut revision
Created attachment 44566 [details] Glut revision
Created attachment 44567 [details] OpenGlut ebuild
Created attachment 44573 [details] OpenGlut ebuild Uncorrect use of dosym in previous version.
FYI Julien, I'm already on the x11 alias. A documentation package probably fits well in app-doc, don't you think. I'm a little concerned that since freeglut and openglut are forks, the documentation could diverge (or already has) as the functionality does so it won't match what freeglut does. Thoughts? When you're attaching changes to things, remember to use `diff -urN` to create a patch rather than attaching a complete file. Thanks. What's the rationale for adding openglut to portage? Is there demand for it? Who's going to maintain it?
Sorry for having cc you, I forgot posts are distributed to internal gentoo lists. Honestly, I've been a bit annoyed with the section where to put the openglut-doc ebuild. Some dev-docs are sometimes in dev-util (gtk-doc), sometimes in the dev related field section (python-docs). I wasn't aware of the `app-doc` section but it seems to be a better place :) As for the freeglut VS openglut divergence, I think those libraries are compliant (I haven't read openglut documentation so far). In fact, this is a freeglut developer that pointed me to that documentation. In my opinion, supporting openglut seems to be a better alternative than supporting freeglut, for the following reasons : Last freeglut release in now one year old. The main developer dropped out (cf README file). OpenGlut is a more active project (last release in October 2004) and this is clear that its policy is to extend freeglut. So, in term of features, I think OpenGlut is about to be more up-to-date. At last, openglut website precises that their API is source-compatible with the official GLUT API. So I think we shouldn't be affraid of any documentation divergence. I saw debian also provided a documenation package for GLUT. I contacted the developer in order to have a feedback but no answer yet... As for the ebuild revision, I thought about a patch but... I also thought it worth a revision ;). As for the rationale to support openglut, I think I brought answer element above ;) I don't really know it there's a real user-demand for openglut... Maybe it could worth a vote post on gentoo forums ? What do you think about that ? "Who's going to maintain it ?" : this is a more serious question. I guess you're terribly overflowed with x11 support. Honestly, I've no idea. I do not know how many people are in the x11-team. If it only dealt with me, I'd propose myself to maintain it but I guess it's not that easy :) ++ julien
Nota: OpenGlut's ABI is not compatible with FreeGlut's one. This leads to undesirable effects when shifting from FreeGlut to OpenGlut, for particular top-level applications. For example, with torcs (this is the only case where I saw that), backface culling gets inverted (!) when shifting from FreeGlut to OpenGlut. This means that, in the case OpenGlut would be supported by Gentoo, users would have to re-compile their 3D top-levels applications, which is very a serious issue. Therefore, I think supporting OpenGlut would be a very good point but needs more investigations and reflections. ++ julien
How about freeglut with glut? Have you seen anything there?
quoting Jamie Wilkinson (Debian Glut maintainer) in a discussion I had with him: "the 2 are definitely source compatible, freeglut is intended to be a complete replacement for GLUT. The documentation for GLUT will work with freeglut. however, the documentation for GLUT is distributed under the same license as GLUT, so until freeglut makes some documentation to match, I'm not shipping any in Debian. That decision is up to you, of course, when packaging for Gentoo." "OpenGlut and freeglut's goals are different, which means that OpenGlut may start introducing features not originally found in the original." As for me, swithing from GLUT to freeglut (with no recompilings) makes no visible difference (such as the bfc inversion ;)).
No man pages here because there are none upstream. Feel free to file a bug with them and post the URL here.
*** Bug 154360 has been marked as a duplicate of this bug. ***
GLUT documentation downloadable, see bug #154395
(In reply to comment #15) > GLUT documentation downloadable, see bug #154395 > But a pain to get installing. Ebuilds are welcome :)
Created attachment 105063 [details] glut-3.7.1.ebuild glut ebuild using tarball linked from bug 154395. Man page build/installation controlled by "doc" USE flag.
(In reply to comment #13) > No man pages here because there are none upstream. Feel free to file a bug with > them and post the URL here. Yah. URL to man pages is at bug 154395; they're for 3.7 not 3.7.1 but it's not like the functions have changed. Uh, submitter or dev please reopen this bug. Thanks.
> Uh, submitter or dev please reopen this bug. Thanks. reopened.
Just out of curiosity do we really really need those manpages? Based on what i can see on their web they describe quite well the functions there... The thing is that glut is going away and only freeglut is going to be around in gentoo.
freeglut does indeed ship html documentation and I don't mind the ebuild having a "doc" USE flag. If anyone really wants this, please provide a proper patch to the latest version of freeglut's ebuild and we'll review it. Thanks
