Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 269071 - gentoolkit documentation (man pages, online docs) need to be updated before release
Summary: gentoolkit documentation (man pages, online docs) need to be updated before r...
Status: RESOLVED FIXED
Alias: None
Product: Portage Development
Classification: Unclassified
Component: Tools (show other bugs)
Hardware: All Linux
: High blocker (vote)
Assignee: Sven Vermeulen (RETIRED)
URL:
Whiteboard:
Keywords:
: 132192 (view as bug list)
Depends on: 269831 273466
Blocks: 237964
  Show dependency tree
 
Reported: 2009-05-08 22:52 UTC by Douglas Anderson
Modified: 2011-08-15 19:31 UTC (History)
4 users (show)

See Also:
Package list:
Runtime testing required: ---
fuzzyray: Bugday+


Attachments
First draft of update equery man page (equery.1,14.96 KB, text/plain)
2009-08-17 04:25 UTC, Douglas Anderson
Details
Updated equery section for http://www.gentoo.org/doc/en/gentoolkit.xml (gentoolkit.xml,30.75 KB, application/xml)
2009-10-20 06:25 UTC, Douglas Anderson
Details
html version of gentoolkit.xml for ease of proof-reading (gentoolkit.html,46.49 KB, text/plain)
2009-10-20 06:27 UTC, Douglas Anderson
Details
This patch removes the typos from gentoolkit.xml file. (gentoolkit.xml.patch,1.15 KB, text/plain)
2010-04-18 19:15 UTC, Bartłomiej Majka
Details
updated gentoolkit.xml (gentoolkit.xml,31.45 KB, application/xml)
2011-05-10 23:27 UTC, Paul Varner (RETIRED)
Details
gentoolkit.xml diff (gentoolkit.xml.patch,31.62 KB, patch)
2011-06-24 19:35 UTC, Paul Varner (RETIRED)
Details | Diff
Path to fix some issues found while updating spanish translation of gentoolkit.xml (gentoolkit.xml.patch,7.49 KB, patch)
2011-08-15 17:31 UTC, Chema Alonso Josa (RETIRED)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Douglas Anderson 2009-05-08 22:52:00 UTC
There have been a lot of changes in this this version of gentoolkit, and the man pages need to be updated accordingly.

I haven't looked over it carefully yet, but this document will probably need to be updated as well:
http://www.gentoo.org/doc/en/gentoolkit.xml

I'll do the equery man page. Can anyone else who made big changes for this release can send patches for the man page, too?
Comment 1 michael@smith-li.com 2009-05-25 22:02:20 UTC
*** Bug 132192 has been marked as a duplicate of this bug. ***
Comment 2 Douglas Anderson 2009-08-17 04:25:37 UTC
Created attachment 201492 [details]
First draft of update equery man page

Requesting a proof-read. I haven't had a lot of time to work on this recently, so if you have improvements of any kind, including better or more interesting examples, please attach your patch.
Comment 3 Douglas Anderson 2009-08-17 04:28:37 UTC
@tools-portage: this and other updates are in my svn repo @ genscripts.googlecode.com.
Comment 4 Douglas Anderson 2009-10-20 06:25:11 UTC
Created attachment 207627 [details]
Updated equery section for http://www.gentoo.org/doc/en/gentoolkit.xml
Comment 5 Douglas Anderson 2009-10-20 06:27:42 UTC
Created attachment 207628 [details]
html version of gentoolkit.xml for ease of proof-reading

I've updated the equery section for http://www.gentoo.org/doc/en/gentoolkit.xml. This should wrap up this bug. Please proof read.
Comment 6 Paul Varner (RETIRED) gentoo-dev 2010-01-07 16:07:24 UTC
I have placed the gentoolkit.xml file at:
http://dev.gentoo.org/~fuzzyray/gentoolkit.xml

Once we are ready to go stable with gentoolkit-0.3.0, I will add the docs team to the bug for updating the main documentation page.
Comment 7 Paul Varner (RETIRED) gentoo-dev 2010-04-08 14:56:03 UTC
Flagging for Bugday, since I need people to review and verify:
http://dev.gentoo.org/~fuzzyray/gentoolkit.xml
Comment 8 Bartłomiej Majka 2010-04-18 19:15:30 UTC
Created attachment 228315 [details]
This patch removes the typos from gentoolkit.xml file.
Comment 9 Paul Varner (RETIRED) gentoo-dev 2011-05-10 23:27:12 UTC
Created attachment 272787 [details]
updated gentoolkit.xml

Most current copy of gentoolkit.xml
Comment 10 Paul Varner (RETIRED) gentoo-dev 2011-05-10 23:33:37 UTC
Docs team, 

I'm going to request the stabilization of gentoolkit-0.3.0.1 shortly.  There are significant changes in the documentation.  I have attached the most recent version of gentoolkit.xml that I have been maintaining in my dev space.

Let me know how best to coordinate this change and what you would like from me to assist.
Comment 11 nm (RETIRED) gentoo-dev 2011-05-31 19:14:59 UTC
(In reply to comment #10)
> Docs team, 
> 
> I'm going to request the stabilization of gentoolkit-0.3.0.1 shortly.  There
> are significant changes in the documentation.  I have attached the most recent
> version of gentoolkit.xml that I have been maintaining in my dev space.
> 
> Let me know how best to coordinate this change and what you would like from me
> to assist.

Just attach a patch with the diff -Nut of your changes to the one in /doc/en/, and be sure to reassign this bug to the GDP once stuff is taken care of on the ebuild side.
Comment 12 Paul Varner (RETIRED) gentoo-dev 2011-06-24 19:35:22 UTC
Created attachment 278035 [details, diff]
gentoolkit.xml diff

Updated diff to /doc/en/gentoolkit.xml
Comment 13 Paul Varner (RETIRED) gentoo-dev 2011-06-24 19:40:56 UTC
Docs team, gentoolkit-0.3.0.4 is stable. on x86/amd64.  The latest attachement is the diff -Nut of /doc/en/gentoolkit.xml.
Comment 14 Sven Vermeulen (RETIRED) gentoo-dev 2011-08-14 17:03:58 UTC
Thanks. I've updated the changes a bit to comply with the coding style as well as a few minor grammar changes. No content though.

Thanks for the patch! Now in CVS, available on the site in an hour or so.
Comment 15 Chema Alonso Josa (RETIRED) gentoo-dev 2011-08-15 17:31:22 UTC
Created attachment 283455 [details, diff]
Path to fix some issues found while updating spanish translation of gentoolkit.xml

Patch to fix:
Wrong caption for mozilla-firefox.
Missing <c> label for equery command.
Trailing spaces and paragraph wrapping.
Comment 16 Sven Vermeulen (RETIRED) gentoo-dev 2011-08-15 19:31:12 UTC
Thanks, I've committed these too (separated, one fix for the caption and command->module change, the rest as coding style).