Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 123786 - wxWidgets almost no documentation
Summary: wxWidgets almost no documentation
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: New packages (show other bugs)
Hardware: All Linux
: High normal
Assignee: Gentoo wxWidgets project
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 136924
  Show dependency tree
 
Reported: 2006-02-22 22:09 UTC by Michal Kurgan (RETIRED)
Modified: 2006-09-24 05:41 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments
wxWidgets-book-1.ebuild (wxWidgets-book-1.ebuild,724 bytes, text/plain)
2006-03-25 00:12 UTC, Ingo Bormuth
Details
wxlib.eclass (wxlib.eclass,3.61 KB, text/plain)
2006-03-25 00:16 UTC, Ingo Bormuth
Details
wxlib.eclass.patch (wxlib.eclass.patch,1.00 KB, patch)
2006-03-25 00:17 UTC, Ingo Bormuth
Details | Diff
installed-docs.txt (installed-docs.txt,210.80 KB, text/plain)
2006-03-25 00:20 UTC, Ingo Bormuth
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Michal Kurgan (RETIRED) gentoo-dev 2006-02-22 22:09:01 UTC
wxlib eclass is used to install wxWidgets documentation, but it uses only a small part of it and with bad manner.

dohtml is used but it only copies files, and don't go recursively and don't work with directories, in case of other packages cp is used to copy multilevel html documentation (like python-docs-2.4.2). But i must admit i don't know exactly how dohtml works, this is only my thought about it and results for wxGTK ebuild.
Comment 1 Ingo Bormuth 2006-03-25 00:12:16 UTC
Created attachment 83067 [details]
wxWidgets-book-1.ebuild


Ebuild for the book "Cross-Platform GUI Programming with wxWidgets"
by Stefan Csomor, Kevin Hock and Julian Smart published by Prentice Hall
under OPL.

This should go to app-doc/wxWidgets-book/
Comment 2 Ingo Bormuth 2006-03-25 00:16:11 UTC
Created attachment 83068 [details]
wxlib.eclass


Modified version of wxlib.eclass

 - optionally depend on app-doc/wxWidgets-book
 - fix Homepage
 - fix installation of docs
Comment 3 Ingo Bormuth 2006-03-25 00:17:31 UTC
Created attachment 83069 [details, diff]
wxlib.eclass.patch


This patch just show the changes made in wxlib.eclass
Comment 4 Ingo Bormuth 2006-03-25 00:20:39 UTC
Created attachment 83070 [details]
installed-docs.txt


List of files now being installed in /usr/share/doc

$ equery f wxGTK | grep "share/doc"
Comment 5 Ingo Bormuth 2006-03-25 00:21:54 UTC
Comment on attachment 83069 [details, diff]
wxlib.eclass.patch

This patch just shows the changes made in wxlib.eclass
Comment 6 Mart Raudsepp gentoo-dev 2006-04-20 13:33:17 UTC
I do not feel adding a book like this comfortable, especially it being a published one. A separate ebuild perhaps, but it's a simple PDF download from the O'Reilly network.
Would correctly installing the whole reference manual with doc USE flag suffice?
Comment 7 Mark Loeser (RETIRED) gentoo-dev 2006-04-20 21:29:06 UTC
Downloading and "installing" a pdf seems quite wasteful.  Lets just make it so USE=doc installs the documentation that comes with wxwidgets.
Comment 8 Mart Raudsepp gentoo-dev 2006-08-06 23:11:13 UTC
(In reply to comment #5)
> This patch just shows the changes made in wxlib.eclass

All these Makefile.*-s that aren't relevant to our build systems takes quite a bit of space.
I don't find a reason to install anything from the utils/ directory as documentation (even though it seems like old versions tried to do that). demos has the same problem as samples.
I will have to try to hack some on the build system probably.
When I'm happy with what files are installed out of samples/ and so on, I will add an "examples" USE flag for that. USE=doc will just mean if the html documentation will be downloaded and installed.


Consider HOMEPAGE fixed.
Comment 9 Mart Raudsepp gentoo-dev 2006-09-24 05:41:03 UTC
wxGTK-2.6.3.3 should install HTML docs now with USE=doc, and some basic text files always (changes.txt, etc).

I hope to look at adding examples at some later date. Needs some sorting out in the build system to do it in a clean manner.

Docs should be covered now, so closing bug :)