Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 302731 - PMS generated documentation outdated
Summary: PMS generated documentation outdated
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Project-specific documentation (show other bugs)
Hardware: All All
: High enhancement (vote)
Assignee: PMS/EAPI
URL: http://www.gentoo.org/proj/en/qa/pms.xml
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-01-29 09:52 UTC by Martin von Gagern
Modified: 2010-02-08 17:36 UTC (History)
1 user (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 Martin von Gagern 2010-01-29 09:52:59 UTC
http://www.gentoo.org/proj/en/qa/pms.xml has compiled versions of the PMS specification linked in its section 4. The documentation seems to be severely outdated, though: "Current HEAD" dates from 2009-05-14, and there is no version corresponding to the git tag eapi-3-approved-2010-01-18. It would be nice to be able to view recent versions, especially those also available from the app-doc/pms ebuild. As an alternative, you might drop these links completely and ask users to emerge the app-doc/pms package. That solution is inferior to updated documentation, but still better than these outdated documents.

Reproducible: Always

Steps to Reproduce:
1. Browse http://www.gentoo.org/proj/en/qa/pms.xml
2. Select "Current HEAD" in section 4
3. Browse to html dir
4. look at documents
Actual Results:  
Version from 2009-05-14 without EAPI 3

Expected Results:  
Current HEAD, or at least a link to a version containing EAPI 3
Comment 1 Christian Faulhammer (RETIRED) gentoo-dev 2010-01-29 12:52:15 UTC
I should add that PMS is available up to date from app-doc/pms, but the page should be fixed, nonetheless.
Comment 2 Christian Faulhammer (RETIRED) gentoo-dev 2010-02-08 15:52:29 UTC
Current head versions are nothing I want to handle, but at least I linked a EAPI 3 PDF document.
Comment 3 Martin von Gagern 2010-02-08 16:55:45 UTC
(In reply to comment #2)
> Current head versions are nothing I want to handle, but at least I linked a
> EAPI 3 PDF document.

Thanks already, but the fix is incomplete:
1. Link contains a space which breaks it.
2. The sentence "Both HTML and PDF versions of the document are available." directly preceding the links to PDF versions only is confusing resp. incorrect.
Comment 4 Christian Faulhammer (RETIRED) gentoo-dev 2010-02-08 17:36:46 UTC
Thanks for checking.