Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 138524 - Potential DHCP pitfall
Summary: Potential DHCP pitfall
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs on www.gentoo.org
Classification: Unclassified
Component: Installation Handbook (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Xavier Neys (RETIRED)
URL: http://www.gentoo.org/doc/en/handbook...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-06-29 13:25 UTC by Arun Raghavan (RETIRED)
Modified: 2006-09-08 03:53 UTC (History)
1 user (show)

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


Attachments
Patch to extend the DHCP note (handbook-x86-minor-dhcp-clarification.patch,664 bytes, patch)
2006-06-29 13:27 UTC, Arun Raghavan (RETIRED)
Details | Diff
Explicitly tell the user to merge dhcpcd during config (hb-install-config.xml.patch,418 bytes, patch)
2006-06-29 23:24 UTC, Arun Raghavan (RETIRED)
Details | Diff
Let the user know about DHCP client options up front (hb-install-tools.xml.patch,746 bytes, patch)
2006-06-29 23:25 UTC, Arun Raghavan (RETIRED)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Arun Raghavan (RETIRED) gentoo-dev 2006-06-29 13:25:52 UTC
Section 9.f states that installing the DHCP client is optional. This section, IMO, is *not* optional for a lot of users. It'd be nice to let a user know that the DHCP client installation is necessary before getting to the "Optional" section.

I know this sounds rather obscure, but think about this from the perspective of a user who has spent the last few hours reading through the maunal and installing Gentoo. Skipping optional parts might seem so much simpler after this. Yes, I know it is blasphemous to even think that the user might skip a section, but it *does* say "Optional".

I believe that making this process more explicit will only make life easier for a lot of people.
Comment 1 Arun Raghavan (RETIRED) gentoo-dev 2006-06-29 13:27:30 UTC
Created attachment 90468 [details, diff]
Patch to extend the DHCP note

This is a small patch that informs the user up front that installing a DHCP client would be a good idea if (s)he is using DHCP.
Comment 2 nm (RETIRED) gentoo-dev 2006-06-29 17:34:35 UTC
To quote from that section of the handbook:

"If you require Gentoo to automatically obtain an IP address for your network interface(s), you need to install dhcpcd (or any other DHCP Client) on your system. If you don't do this now, you might not be able to connect to the internet after the installation!"

How is this in any way unclear that if you do need an automatic IP address (explained in all previous references to dhcp), you must install a dhcp client?

By the way, patches against html are no good, see http://www.gentoo.org/proj/en/gdp/doc/doc-tipsntricks.xml for how to create proper patches. :)
Comment 3 Arun Raghavan (RETIRED) gentoo-dev 2006-06-29 21:59:27 UTC
Josh, what I'm saying is that the "Optional" tag on the section is misleading -- a user may (rightly) feel that this can be skipped for now, since it is optional.

It might seem like nitpicky semantics, but I think this is a valid concern -- for users of DHCP, installing a DHCP client is *not* optional -- if this is skipped, the user is left with a Gentoo install that is functionally incomplete (if I can't do an 'emerge --sync', the system is functionall incomplete). I think it is reasonable to at least explain to the user what needs to be done. Technically, the same applies for PPPoE as well.

Besides, not everybody even understands what DHCP/PPPoE are. I'm not saying that we should make this a Computer Systems Administration 101, but a small explanatory note before the Optional sections begin won't hurt.

Sorry about the HTML diff -- I was wondering why the whole thing looks so different nowadays. :)
Comment 4 Arun Raghavan (RETIRED) gentoo-dev 2006-06-29 23:24:42 UTC
Created attachment 90509 [details, diff]
Explicitly tell the user to merge dhcpcd during config
Comment 5 Arun Raghavan (RETIRED) gentoo-dev 2006-06-29 23:25:15 UTC
Created attachment 90510 [details, diff]
Let the user know about DHCP client options up front
Comment 6 Arun Raghavan (RETIRED) gentoo-dev 2006-06-29 23:27:42 UTC
Updated patches (against original XML :p):

1) Let's tell the user about DHCP clients while (s)he is setting up networking
2) Let's also point to the list of available clients at this point (someone said something about choice *grin*)
Comment 7 Shyam Mani (RETIRED) gentoo-dev 2006-06-30 00:25:12 UTC
After seeing the patches, I'm inclined to add the info in. It's quite trivial and removes confusion (if any existed in the first place). If no one has objections, I'll put it in after like 2 days or so.
Comment 8 Jan Kundrát (RETIRED) gentoo-dev 2006-06-30 04:03:59 UTC
Patches look good.
Comment 9 Łukasz Damentko (RETIRED) gentoo-dev 2006-09-04 02:47:39 UTC
There's a typo in those patches that you said are okay (Sysyem). 
Except that, i think this info should go in, additional clarification in this matter doesn't cost us much and can save many.
Comment 10 Arun Raghavan (RETIRED) gentoo-dev 2006-09-08 03:25:18 UTC
(In reply to comment #9)
> There's a typo in those patches that you said are okay (Sysyem). 
> Except that, i think this info should go in, additional clarification in this
> matter doesn't cost us much and can save many.

I heartily agree. <looks meaningfully at fox2mike>
Comment 11 Xavier Neys (RETIRED) gentoo-dev 2006-09-08 03:42:16 UTC
Hands up! This is a hijacking
Comment 12 Xavier Neys (RETIRED) gentoo-dev 2006-09-08 03:53:48 UTC
(In reply to comment #8)
> Patches look good.

(In reply to comment #9)
> There's a typo in those patches that you said are okay (Sysyem). 

He he, you both missed the missing &amp; entity.
/me wonders about requesting another go at the fix-me ;-)

Committed.
Thanks a lot for your suggestion and patches.