Bug 147038 – app-portage/portage-utils: improving its man pages

• Status: RESOLVED FIXED
• Product: Portage Development

[Description Benno Schulenberg 2006-09-10 03:44:39 UTC]

Currently the q man pages say unhelpful things like "qlop - manual page for qlop" and give the description of the command in italics under the Synopsis.  Attached patch changes this to the normal arrangement: description under Name, and only the synopsis under Synopsis.  In the process it adds a description for the q command itself, and changes "[arguments]..." to "<arguments>" to make the second 'sed' work.  This last thing may be less correct, but makes it similar to the rest of the page.

[Comment 1 Benno Schulenberg 2006-09-10 03:46:17 UTC]

Created attachment 96569 [details, diff]
create normal description and synopsis in q man pages

[Comment 2 Benno Schulenberg 2006-09-10 10:52:22 UTC]

Created attachment 96603 [details, diff]
improved patch, blending the new sed into the existing one

[Comment 3 solar (RETIRED) 2006-09-10 12:42:02 UTC]

TGL, Please review

[Comment 4 TGL 2006-09-10 13:43:59 UTC]

Created attachment 96609 [details, diff]
portage-utils-0.1.21--man-page-description-3.patch

> TGL, Please review

I like it.

Attached is a revised version, with only minor changes:
 - s/"invoke a portage query applet"/"invoke a portage utility applet"/, because portage-utils is not only about querying (think qmerge, qxpack, etc.)
 - replaced a "grep | sed" with a simple "sed", because they hurt my eyes
 - modified the SYNOPSIS sed command to make sure it applies only in the SYNOPSIS section

[Comment 5 SpanKY 2006-09-10 22:54:20 UTC]

thanks, added to cvs