Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 341021 - modules=( "word" ) is terrible advice, should be modules+=( "word" ) in all places
Summary: modules=( "word" ) is terrible advice, should be modules+=( "word" ) in all p...
Status: RESOLVED WONTFIX
Alias: None
Product: [OLD] Docs on www.gentoo.org
Classification: Unclassified
Component: Installation Handbook (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Docs Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-10-14 18:18 UTC by Robert White
Modified: 2010-10-15 03:46 UTC (History)
0 users

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


Attachments
UNTESTED patch of intended change (handbook.patch,3.24 KB, patch)
2010-10-14 18:35 UTC, Robert White
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Robert White 2010-10-14 18:18:32 UTC
It is not immediately evident to a non-bash-programmer that having two module=( "something" ) lines in /etc/conf.d/net leads to all but the last such line being discarded.

Consequently if someone wanted to do more than one thing from /etc/conf.d/net.examples they could naively copy the examples file and go uncommenting lines expecting it to work.

In the same context, if every occurance of the array assignment "module=()" were substituted with the array append operator "module+=()" the right thing(s) would just happen.

I would recommend s/module=/module+=/g on the whole network section, and the addition of a "note" near the first mention of modules that the user should use the append operator _or_ collect all the module configuration tidbits into one place. 

Reproducible: Always

Steps to Reproduce:
1. module=( "dhclient" )
2. module=( "iproute2" )
3. Notice that dhclient module is not honored
Comment 1 Robert White 2010-10-14 18:21:42 UTC
grr... substitute "modules" for "module" in the whole of the above. 
Comment 2 Robert White 2010-10-14 18:35:19 UTC
Created attachment 250605 [details, diff]
UNTESTED patch of intended change

This is a vim-created patch to the amd64 handbook. This is an example of potential replacement text.

This patch is "untested" because I cannot display the handbook in icecat from the local xml file, I presume its because it is missing some doctype or css prefix when you save-as the link from the gentoo page.
Comment 3 nm (RETIRED) gentoo-dev 2010-10-15 03:46:04 UTC
We don't take patches against HTML, which is what you provided, sorry.

Also, we're not going to use complicated bash expanders in the handbook, both for explanation's sake and because all the net arrays in that style are going away once we rewrite the docs for OpenRC/baselayout-2. Thanks for the ideas, though; it's proof that there's more than one way to do things in Gentoo!