Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 34048 - Use "spelled-out" options in instructions
Summary: Use "spelled-out" options in instructions
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs-user
Classification: Unclassified
Component: Handbook (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Sven Vermeulen (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2003-11-21 11:55 UTC by roger55 (RETIRED)
Modified: 2003-11-23 08:27 UTC (History)
1 user (show)

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


Attachments
Patch to hb-install-bootloader.xml (hb-install-bootloader.diff,1.61 KB, patch)
2003-11-23 06:44 UTC, Sven Vermeulen (RETIRED)
Details | Diff
Patch to hb-install-config.diff (hb-install-config.diff,289 bytes, patch)
2003-11-23 06:45 UTC, Sven Vermeulen (RETIRED)
Details | Diff
Patch to hb-install-finalise.xml (hb-install-finalise.diff,642 bytes, patch)
2003-11-23 06:45 UTC, Sven Vermeulen (RETIRED)
Details | Diff
Patch to hb-install-kernel.xml (hb-install-kernel.diff,2.93 KB, patch)
2003-11-23 06:46 UTC, Sven Vermeulen (RETIRED)
Details | Diff
Patch to hb-install-system.xml (hb-install-system.diff,1.17 KB, patch)
2003-11-23 06:46 UTC, Sven Vermeulen (RETIRED)
Details | Diff
Patch to hb-install-tools.xml (hb-install-tools.diff,1.02 KB, patch)
2003-11-23 06:46 UTC, Sven Vermeulen (RETIRED)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description roger55 (RETIRED) gentoo-dev 2003-11-21 11:55:08 UTC
The handbook should use the long options instead of the shortened 
'one-letter-options' 
 
example: 
 
emerge --usepkg kde 
 
instead of 
 
emerge -k kde 
 
This will teach new users better what these options are for.  
 
roger55 

Reproducible: Always
Steps to Reproduce:
1.
2.
3.
Comment 1 Sven Vermeulen (RETIRED) gentoo-dev 2003-11-23 06:44:57 UTC
Created attachment 21140 [details, diff]
Patch to hb-install-bootloader.xml
Comment 2 Sven Vermeulen (RETIRED) gentoo-dev 2003-11-23 06:45:26 UTC
Created attachment 21141 [details, diff]
Patch to hb-install-config.diff
Comment 3 Sven Vermeulen (RETIRED) gentoo-dev 2003-11-23 06:45:49 UTC
Created attachment 21142 [details, diff]
Patch to hb-install-finalise.xml
Comment 4 Sven Vermeulen (RETIRED) gentoo-dev 2003-11-23 06:46:10 UTC
Created attachment 21143 [details, diff]
Patch to hb-install-kernel.xml
Comment 5 Sven Vermeulen (RETIRED) gentoo-dev 2003-11-23 06:46:35 UTC
Created attachment 21144 [details, diff]
Patch to hb-install-system.xml
Comment 6 Sven Vermeulen (RETIRED) gentoo-dev 2003-11-23 06:46:56 UTC
Created attachment 21145 [details, diff]
Patch to hb-install-tools.xml
Comment 7 Sven Vermeulen (RETIRED) gentoo-dev 2003-11-23 06:48:25 UTC
These patches should fix this in all existing files. There is also a small introduction about the "--usepkg" flag (and the "-k" abbreviation) in the hb-install-kernel.xml patch as the user is there confronted with it for the first time.

If a docdev can review?
Comment 8 Erwin (RETIRED) gentoo-dev 2003-11-23 07:11:48 UTC
hb-install-kernel.xml: s/prebuild/prebuilt/

Other patches look good.
Comment 9 Sven Vermeulen (RETIRED) gentoo-dev 2003-11-23 08:27:59 UTC
Thanks. Change applied and patches committed.