Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 137619 - >=dev-python/twisted-2 needs installable api docs
Summary: >=dev-python/twisted-2 needs installable api docs
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All All
: High minor (vote)
Assignee: Thomas Raschbacher
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-06-22 10:21 UTC by Sascha Silbe
Modified: 2010-08-19 09:24 UTC (History)
2 users (show)

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


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Sascha Silbe 2006-06-22 10:21:34 UTC
Because there are two separate packages twisted and twisted-docs and the first one doesn't support USE=doc, I tried to install the latter one (because I need the documentation).
But twisted-docs show file collisions with twisted. After some investigation it seems that twisted-2.* includes the documentation (and that's probably the reason why twisted-docs is still at 1.2.0).
It would be great if you could add some hint to the description of twisted-docs that it's only for twisted-1.2* and that twisted-2.* already includes documentation.
Comment 1 Marien Zwart (RETIRED) gentoo-dev 2006-06-22 12:20:25 UTC
I thought the version numbers would provide you with enough hints, but I was not aware it collided. Just removed a bunch of old versions and made it and twisted-2 block each other. Most of the documentation is just installed unconditionally (it is imho not large enough to need a doc USE flag). 

The main thing that's missing is api docs. Use http://twistedmatrix.com/documents/current/api/ for that for now. I'm morphing this bug into a reminder for me that we need installable api docs somehow (I know how to generate the documentation, but I don't know how to deal with the split-up subpackages nicely).
Comment 2 Sascha Silbe 2006-06-22 13:43:29 UTC
Thanks!
To be honest, I didn't look at the version numbers 'till it flew apart.
Comment 3 Peter `MathFox' Roozemaal 2006-06-23 04:26:21 UTC
I was wondering why suddenly twisted-docs was blocking the twisted package (I guess twisted-docs-1.2.0 was installed with twisted-1.2.0; I upgraded to twisted-2.4.0... ~amd64) The twisted-docs package was not in my world file.

Generating the api-docs depending on the settings of the "doc" use flag would imo be a good way to handle it; it's the way most Gentoo packages handle it.
Comment 4 Thomas Raschbacher gentoo-dev 2009-03-27 09:07:08 UTC
i'll take care of this since marienz has gone quite a while ago now .. and I want to sort out several twisted ebuilds anyway ..
Comment 5 Brian Harring (RETIRED) gentoo-dev 2010-08-19 09:24:41 UTC
15 months later, twisted-docs doesn't exist in the tree, and twisted 10.0 bundles some docs...

Reopen if incorrect, but this looks resolved.