Bug 36465

Summary: dumpon(8) manual misleads about single/multi-user usability
Product: Documentation Reporter: Gary W. Swearingen <swear>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Gary W. Swearingen 2002-03-29 05:50:00 UTC
The dumpon(8) manual's NOTES section has this:

    Since dumpon can only be called after the system enters single-user
    mode, it can not be used to create dumps for system panics during
    kernel initialization.  In such cases use dumpdev tunable provided
    by loader(8) instead.

from which some will infer that dumpon may not be used in multi-user mode.
================

Fix: 

Replace the whole paragraph with:

    Since _dumpon_ cannot be used during kernel initialization, the
    _dumpdev_ variable of loader(8) must be used to enable dumps
    for system panics during kernel initialization.
How-To-Repeat: n/a
================
Comment 1 Tom Rhodes freebsd_committer freebsd_triage 2002-03-29 06:25:45 UTC
--- dumpon.8.old	Fri Mar 29 01:21:52 2002
+++ dumpon.8	Fri Mar 29 01:22:00 2002
@@ -96,8 +96,11 @@
 .Pp
 Since
 .Nm
-can only be called after the system enters single-user mode,
-it can not be used to create dumps for system panics during
+cannot be used during kernel initialization, the
+.Va dumpdev
+variable of
+.Xr loader 8
+must be used to enable dumps for system panics during
 kernel initialization.
 In such cases use
 .Va dumpdev
Review the above, sorry about that, my new mailer program is odd
Comment 2 Gary W. Swearingen 2002-03-29 17:52:17 UTC
Tom Rhodes <darklogik@pittgoth.com> writes:

> 	Could you review this diff, see if this will be good for ya?
> My mdoc(7) skills arn't the best in the world ;)

Nor are mine, making testing a required part of patching.

Your diff looks good, except that the sentence starting
"In such cases use" (see below) should be removed too (it was
incorporated in the new part).

    +.Xr loader 8
    +must be used to enable dumps for system panics during
     kernel initialization.
     In such cases use
     .Va dumpdev

And if you don't mind, you could remove a possible (but nonsensical)
second meaning in the new text by inserting "which occur" between
"panics" and "during" (see above).  Thanks.
Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2002-04-02 02:39:15 UTC
Gary, this is a new diff that should work for our current
situation.  What do you think?

--
Tom (darklogik) Rhodes

--- dumpon.8.old	Mon Apr  1 20:29:36 2002
+++ dumpon.8	Mon Apr  1 20:43:27 2002
@@ -96,14 +96,12 @@
 .Pp
 Since
 .Nm
-can only be called after the system enters single-user mode,
-it can not be used to create dumps for system panics during
-kernel initialization.
-In such cases use
+cannot be used during kernel initialization, the
 .Va dumpdev
-tunable provided by
+variable of
 .Xr loader 8
-instead.
+must be used to enable dumps for system panics which occur
+during kernel initialization.
 .Sh SEE ALSO
 .Xr sysctl 3 ,
 .Xr fstab 5 ,
Comment 4 Tom Rhodes freebsd_committer freebsd_triage 2002-04-02 06:01:38 UTC
State Changed
From-To: open->analyzed

Submitter has accepted my patch, and I will commit it soon 


Comment 5 Tom Rhodes freebsd_committer freebsd_triage 2002-04-02 06:01:38 UTC
Responsible Changed
From-To: freebsd-doc->trhodes

Submitter has accepted my patch and I will commit it soon
Comment 6 Tom Rhodes freebsd_committer freebsd_triage 2002-04-09 20:58:33 UTC
State Changed
From-To: analyzed->patched

I just applyed to CURRENT, and will apply to stable in 3 days, Thanks 
alot Gary!
Comment 7 Tom Rhodes freebsd_committer freebsd_triage 2002-04-12 17:14:38 UTC
State Changed
From-To: patched->closed

Committed to STABLE!  Thanks Gary!