Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 146468 - devmanual is in need of some love
Summary: devmanual is in need of some love
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Other (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Gentoo Quality Assurance Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-09-05 15:50 UTC by Stephen Bennett (RETIRED)
Modified: 2007-12-16 03:03 UTC (History)
5 users (show)

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


Attachments
Patch for the first issue (devmanual-use-expand.diff,987 bytes, patch)
2006-09-15 15:18 UTC, Stephen Bennett (RETIRED)
Details | Diff
Next patch (devmanual-iuse.diff,593 bytes, patch)
2006-09-15 18:10 UTC, Stephen Bennett (RETIRED)
Details | Diff
[SPELL] hierachical patch (contrib.patch,726 bytes, patch)
2006-09-16 03:44 UTC, Torsten Veller (RETIRED)
Details | Diff
[SPELL] hierachical patch (contrib.patch,826 bytes, patch)
2006-09-16 04:00 UTC, Torsten Veller (RETIRED)
Details | Diff
last thing...I think (bug146468.patch,457 bytes, patch)
2007-11-25 04:45 UTC, Mark Loeser (RETIRED)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Stephen Bennett (RETIRED) gentoo-dev 2006-09-05 15:50:44 UTC
http://devmanual.gentoo.org/general-concepts/use-flags/index.html

USE flag descriptions is wrong -- USE_EXPAND flags should also be documented.

http://devmanual.gentoo.org/ebuild-writing/variables/index.html#iuse

Also wrong.

http://devmanual.gentoo.org/function-reference/query-functions/index.html

use_enable and use_with descriptions are incomplete -- they also have three-argument forms.

http://devmanual.gentoo.org/function-reference/install-functions/index.html

Description for dohtml is misleading at best.

http://devmanual.gentoo.org/profiles/use.desc/index.html
This could probably use expanding (ho ho) with some information about descript files for USE_EXPAND variables.

That's it for the first batch; more to come when I get around to reading through it properly.
Comment 1 Stephen Bennett (RETIRED) gentoo-dev 2006-09-15 15:18:13 UTC
Created attachment 97087 [details, diff]
Patch for the first issue

This patch addresses the first issue -- that USE_EXPAND variables should now be documented as USE flags.
Comment 2 Tim Yamin (RETIRED) gentoo-dev 2006-09-15 17:52:28 UTC
(In reply to comment #1)
> Created an attachment (id=97087) [edit]
> Patch for the first issue

Added, thanks. Note that you don't need to indent text inside <p> tags.
Comment 3 Stephen Bennett (RETIRED) gentoo-dev 2006-09-15 18:10:07 UTC
Created attachment 97107 [details, diff]
Next patch

And another; fixes the IUSE description.
Comment 4 Tim Yamin (RETIRED) gentoo-dev 2006-09-16 03:12:51 UTC
(In reply to comment #3)
> Created an attachment (id=97107) [edit]
> Next patch

Done, your editor is still being screwy with the indentation BTW.
Comment 5 Torsten Veller (RETIRED) gentoo-dev 2006-09-16 03:44:39 UTC
Created attachment 97132 [details, diff]
[SPELL] hierachical patch

same as bug 137205: hierachical -> hierarchical
Comment 6 Torsten Veller (RETIRED) gentoo-dev 2006-09-16 04:00:24 UTC
Created attachment 97138 [details, diff]
[SPELL] hierachical patch

added Hierachy -> Hierarchy
Comment 7 Tim Yamin (RETIRED) gentoo-dev 2006-09-16 06:13:24 UTC
Comment on attachment 97138 [details, diff]
[SPELL] hierachical patch

Fixed, thanks.
Comment 8 Danny van Dyk (RETIRED) gentoo-dev 2007-04-22 14:08:06 UTC
(In reply to comment #0)
> http://devmanual.gentoo.org/function-reference/query-functions/index.html
> 
> use_enable and use_with descriptions are incomplete -- they also have
> three-argument forms.
Fixed in SVN r99.

> http://devmanual.gentoo.org/profiles/use.desc/index.html
> This could probably use expanding (ho ho) with some information about descript
> files for USE_EXPAND variables.
Fixed in SVN r99.

Comment 9 Mark Loeser (RETIRED) gentoo-dev 2007-11-25 04:45:54 UTC
Created attachment 136953 [details, diff]
last thing...I think

I think this was the last of the issues listed in this bug.  Its not much bigger of a description, but it should be better than the last one.
Comment 10 Mark Loeser (RETIRED) gentoo-dev 2007-12-16 03:03:01 UTC
last fix committed