Bug 44595

Summary: Handbook only documents UserConfig for boot-time kernel config
Product: Documentation Reporter: Bruce A. Mah <bmah>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Bruce A. Mah freebsd_committer freebsd_triage 2002-10-29 17:20:01 UTC
5.0-CURRENT doesn't have UserConfig, which is used on the i386 (and pc98?)
for configuring parameters of various
(mostly-legacy) devices.  The replacement is the device.hints(5) mechanism,
which has most of the functionality, but a very different user interface.

The Handbook should reflect this (or at least mention there is 
a difference).

Fix: 

At a minimum, turn the above ramblings into English and insert into
the installation chapter of the Handbook.  It'd be better to have a real
"How to do boot-time kernel configuration on 5.X" section, but that's
more work.
Comment 1 Tom Rhodes freebsd_committer freebsd_triage 2002-11-07 03:53:43 UTC
Isn't this what we use device.hints(5) for?  Or do we need to document
yet another mechanism for configuring things at during the boot
operation?

--
Tom Rhodes
Comment 2 Bruce A. Mah freebsd_committer freebsd_triage 2002-11-07 16:14:30 UTC
If memory serves me right, Tom Rhodes wrote:
> Isn't this what we use device.hints(5) for?  Or do we need to document
> yet another mechanism for configuring things at during the boot
> operation?

Yes, that's what device.hints(5) does.  The problem is that there is no
mention of this mechanism in the handbook's install chapter *at all*.
Unless we at least mention device.hints(5), we're going to get a lot of
confused new 5.0 users asking "Where's my UserConfig?"

Bruce.

Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2002-11-07 21:12:38 UTC
On Thu, 07 Nov 2002 08:14:30 -0800
bmah@FreeBSD.org (Bruce A. Mah) wrote:

> If memory serves me right, Tom Rhodes wrote:
> > Isn't this what we use device.hints(5) for?  Or do we need to
> > document yet another mechanism for configuring things at during the
> > boot operation?
> 
> Yes, that's what device.hints(5) does.  The problem is that there is
> no mention of this mechanism in the handbook's install chapter *at
> all*. Unless we at least mention device.hints(5), we're going to get a
> lot of confused new 5.0 users asking "Where's my UserConfig?"
> 
> Bruce.
> 
> 
> 

I added information about device.hints(5) to the boot chapter.  Would
a quick paragraph which:

Explains that UserConfig is not in 5.0
Users must see the device.hints(5) manual page and/or
Read THIS section of the handbook for information on device.hints(5)

be sufficient?  Or do you have a better approach?

--
Tom Rhodes
Comment 4 Bruce A. Mah freebsd_committer freebsd_triage 2002-11-08 02:10:04 UTC
If memory serves me right, Tom Rhodes wrote:

> I added information about device.hints(5) to the boot chapter.  Would
> a quick paragraph which:
> 
> Explains that UserConfig is not in 5.0

OK.  Remember that it's not just "not in 5.0", but "not in releases 
beginning with 5.0" or something like that.

> Users must see the device.hints(5) manual page and/or

It's really hard to read the manpage if you're installing for the first 
time.  :-)

> Read THIS section of the handbook for information on device.hints(5)

A new user is less likely to want to know about the booting process than
what steps they need to do to get some grotty old ISA Ethernet board to
work.  It's best if you can keep the new text self-contained...I'd like 
to use the install chapter in the handbook to replace INSTALL.TXT 
someday.

> be sufficient?  Or do you have a better approach?

Bruce.

Comment 5 Tom Rhodes freebsd_committer freebsd_triage 2002-11-08 03:31:00 UTC
On Thu, 07 Nov 2002 18:10:04 -0800
bmah@FreeBSD.org (Bruce A. Mah) wrote:

> If memory serves me right, Tom Rhodes wrote:
> 
> > I added information about device.hints(5) to the boot chapter. 
> > Would a quick paragraph which:
> > 
> > Explains that UserConfig is not in 5.0
> 
> OK.  Remember that it's not just "not in 5.0", but "not in releases 
> beginning with 5.0" or something like that.
> 
> > Users must see the device.hints(5) manual page and/or
> 
> It's really hard to read the manpage if you're installing for the
> first time.  :-)
> 
> > Read THIS section of the handbook for information on device.hints(5)
> 
> A new user is less likely to want to know about the booting process
> than what steps they need to do to get some grotty old ISA Ethernet
> board to work.  It's best if you can keep the new text
> self-contained...I'd like to use the install chapter in the handbook
> to replace INSTALL.TXT someday.
> 
> > be sufficient?  Or do you have a better approach?
> 
> Bruce.
> 
> 
> 

Perhaps I'll just 'draft' a paragraph and you review it before I
do the actual commit.  This will keep changes to 1 and hopefully is
good enough to please everyone.

--
Tom Rhodes
Comment 6 Tom Rhodes freebsd_committer freebsd_triage 2002-11-27 23:03:59 UTC
State Changed
From-To: open->closed

Link and explination added to the kernelconfig && install chapters.