Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 387517 - Documentation contains outdated text about KDE 4.5
Summary: Documentation contains outdated text about KDE 4.5
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Project-specific documentation (show other bugs)
Hardware: All Linux
: Normal trivial (vote)
Assignee: Gentoo KDE team
URL: http://www.gentoo.org/proj/en/desktop...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-10-18 09:51 UTC by Thomas Fischer
Modified: 2011-11-04 22:32 UTC (History)
0 users

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 Thomas Fischer 2011-10-18 09:51:53 UTC
The KDE4 Guide (URL see above) contains some sections which are outdated by now. To avoid this situation, the text should be rewritten in a more general form:

Section "Installing KDE snapshots (from kde overlay)":
* "KDE upstream provides weekly snapshots taken from the SVN trunk tree." I remember that KDE is migrating to git, so parts of the code are from SVN and parts from git. My proposal instead: "KDE upstream provides weekly snapshots of its current development code" (or "code under development")
* "KDE now provides 4.5.xx snapshot series, and after the 4.6 release they are going to start with 4.6.60." Version 4.5 is definitely outdated and 4.6 will be phased out soon. Better write "In addition, KDE provides snapshots of Alpha and Beta releases and Release Candidates."
* Before the table, write "Such pre-releases map to version numbers as follows:" instead of "Beta and Release Candidate KDE releases are following the snapshot model below:"
* The table should contain rows for Alpha 1,2,... as well. I guess those have numbers 4.x.6x and 4.x.7x ...

Similar problems on outdated text exist for other sections such as "Installing KDE SC live ebuilds (from kde overlay)" as well:
1. Don't name RCS system directly, as it changes
2. Don't name minor versions like .5, .6, .7 as it will outdate with months. Instead, use .x if possible.


Reproducible: Always
Comment 1 Thomas Fischer 2011-10-18 09:53:59 UTC
As the documentation is based on an XML document, is it possible to define variables such as "currently_stable_version" or "upcoming_version" and use those instead of fixed text like "4.6" or "4.7"?
Comment 2 Andreas K. Hüttel archtester gentoo-dev 2011-10-18 17:53:41 UTC
Sounds great. I dont think the variable option is possible though...

It would be even more awesome if you could come up with a patch for the xml, and attach it here... :) Feel free to add yourself as author of course. 

The current file:
http://www.gentoo.org/proj/en/desktop/kde/kde4-guide.xml?passthru=1
Comment 3 Andreas K. Hüttel archtester gentoo-dev 2011-11-04 22:32:29 UTC
I cleaned up and updated. Should be better now.