Bug 159650

Summary:	[developers-handbook] dumpdev variable was changed to "no" on September 2009
Product:	Documentation	Reporter:	Jeremy Chadwick <freebsd>
Component:	Books & Articles	Assignee:	Ryusuke SUZUKI <ryusuke>
Status:	Closed FIXED
Severity:	Affects Only Me	CC:	killing
Priority:	Normal
Version:	Latest
Hardware:	Any
OS:	Any

Description Jeremy Chadwick 2011-08-10 18:10:09 UTC

	In the following freebsd-stable@ discussion thread, the "dumpdev"
	rc.conf variable and its defaults have come under scrutiny:

	http://lists.freebsd.org/pipermail/freebsd-stable/2011-August/063543.html

	In September 2009 a commit was made to change the default value of
	dumpdev from "AUTO" to "NO":

	http://www.freebsd.org/cgi/cvsweb.cgi/src/etc/defaults/rc.conf#rev1.358.2.2

	Yet the FreeBSD Handbook "Kernel Debugging" section 10.1.1 states:

	"AUTO is the default as of FreeBSD 6.0."

	Which is no longer true for any release/build past September 2009 (sans
	HEAD/CURRENT, where "AUTO" is still the default).

Fix: 

Please update the Handbook to reflect reality.  :-)  Someone will need
	to review the RELENG_7 tag to see if/when src/etc/defaults/rc.conf was
	changed there as well.
How-To-Repeat: 	n/a

Comment 1 Ryusuke SUZUKI freebsd_committer

2011-08-20 15:33:12 UTC

Responsible Changed
From-To: freebsd-doc->ryusuke

I'll take this.

Comment 2 Ryusuke SUZUKI freebsd_committer

2011-08-28 15:38:08 UTC

----Security_Multipart(Sun_Aug_28_23_38_08_2011_097)--
Content-Type: Text/Plain; charset=us-ascii
Content-Transfer-Encoding: 7bit

Hi,

Thanks for your submitting PR/159650.

I also confirmed that dumpdev is set to be "NO", by default,
for RELENG_3, 4, 5, 6, 8 and "AUTO" for RELENG_7, and HEAD
(I suspect that this variable should be "NO" for RELENG_7 as well...).

In the near feature, the RELENG_9 will be branched.
After creating RELENG_9, I will fix this issue.

Regards,
   Ryusuke

----Security_Multipart(Sun_Aug_28_23_38_08_2011_097)--
Content-Type: application/pgp-signature
Content-Transfer-Encoding: 7bit

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (FreeBSD)

iEYEABECAAYFAk5aUtAACgkQG5rRvmPSlyTzWgCeKWGYzlZM7aYbQMBbQUx6qyxc
tS4AmwQY9HsGQuGZBoMU5m3OOizCoqPJ
=yhgs
-----END PGP SIGNATURE-----

----Security_Multipart(Sun_Aug_28_23_38_08_2011_097)----

Comment 3 Ryusuke SUZUKI freebsd_committer

2012-01-07 08:11:03 UTC

----Security_Multipart(Sat_Jan__7_17_11_03_2012_364)--
Content-Type: Text/Plain; charset=us-ascii
Content-Transfer-Encoding: 7bit

Hello,

Last year, I took PR/159650. This PR is related to the crash dump.
http://www.freebsd.org/cgi/query-pr.cgi?pr=docs/159650


As you know, "dumpdev" variable of rc.conf file is "AUTO" in HEAD,
but changed to "NO" on the stable branches.

References
 RELENG_9 : http://www.freebsd.org/cgi/cvsweb.cgi/src/etc/defaults/rc.conf#rev1.394.2.2
 RELENG_8 : http://www.freebsd.org/cgi/cvsweb.cgi/src/etc/defaults/rc.conf#rev1.358.2.2
 RELENG_6 : http://www.freebsd.org/cgi/cvsweb.cgi/src/etc/defaults/rc.conf#rev1.252.2.17


However, developers-handbook "10.1.1 Configuring the Dump Device" only says

     "AUTO is the default as of FreeBSD 6.0."

http://www.freebsd.org/doc/en_US.ISO8859-1/books/developers-handbook/kerneldebug.html#CONFIG-DUMPDEV


We should update this sentence.

And I also would like to mention the crash dump menu of the bsdinstall,
recently kensmith@ added
http://docs.freebsd.org/cgi/getmsg.cgi?fetch=1485239+0+archive/2011/svn-src-all/20111204.svn-src-all

Please review the follwoing patch:

Index: chapter.sgml
===================================================================
RCS file: /home/ryusuke/work/cvs-doc/doc/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml,v
retrieving revision 1.80
diff -u -r1.80 chapter.sgml
--- chapter.sgml	2 Dec 2010 14:53:45 -0000	1.80
+++ chapter.sgml	7 Jan 2012 06:54:34 -0000
@@ -76,8 +76,13 @@
 	&man.rc.conf.5; to the path of the swap device (the
 	recommended way to extract a kernel dump) or
 	<filename>AUTO</filename> to use the first configured swap
-	device.  <filename>AUTO</filename> is the default as of
-	&os;&nbsp;6.0.</para>
+	device.  The defualt for <varname>dumpdev</varname> is
+	<filename>AUTO</filename> in HEAD, and changed to
+	<filename>NO</filename> on RELENG_* branches (exceptionally,
+	it leave <filename>AUTO</filename> in RELENG_7).
+	On &os;&nbsp;9.0-RELEASE and later versions,
+	<application>bsdinstall</application> will prompt if crash dumps
+	should be enabled on the target system during the install process.</para>

       <tip><para>Check <filename>/etc/fstab</filename> or
 	&man.swapinfo.8; for a list of swap devices.</para></tip>



Regards,
  Ryusuke


----Security_Multipart(Sat_Jan__7_17_11_03_2012_364)--
Content-Type: application/pgp-signature
Content-Transfer-Encoding: 7bit

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (FreeBSD)

iEYEABECAAYFAk8H/hcACgkQG5rRvmPSlyTPQQCgg44r+bIGEhkj+275D+Wnh1bo
8OYAnitwXwAElyASJBUHs7lrCGmhmggN
=NIsP
-----END PGP SIGNATURE-----

----Security_Multipart(Sat_Jan__7_17_11_03_2012_364)----

Comment 4 Ryusuke SUZUKI freebsd_committer

2012-01-08 17:39:52 UTC

----Security_Multipart(Mon_Jan__9_02_39_52_2012_186)--
Content-Type: Text/Plain; charset=us-ascii
Content-Transfer-Encoding: 7bit

Benedict-san, Warren-san,

Thanks for reviewing the patch!

I will commit updated follwoing patch in a few days.

Ryusuke


Index: chapter.sgml
===================================================================
RCS file: /home/ryusuke/work/cvs-doc/doc/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml,v
retrieving revision 1.80
diff -u -r1.80 chapter.sgml
--- chapter.sgml	2 Dec 2010 14:53:45 -0000	1.80
+++ chapter.sgml	8 Jan 2012 16:30:52 -0000
@@ -75,9 +75,14 @@
 	handled by setting the <varname>dumpdev</varname> variable in
 	&man.rc.conf.5; to the path of the swap device (the
 	recommended way to extract a kernel dump) or
-	<filename>AUTO</filename> to use the first configured swap
-	device.  <filename>AUTO</filename> is the default as of
-	&os;&nbsp;6.0.</para>
+	<literal>AUTO</literal> to use the first configured swap
+	device.  The default for <varname>dumpdev</varname> is
+	<literal>AUTO</literal> in HEAD, and changed to
+	<literal>NO</literal> on RELENG_* branches (except for RELENG_7,
+	which was left set to <literal>AUTO</literal>).
+	On &os;&nbsp;9.0-RELEASE and later versions,
+	<application>bsdinstall</application> will ask whether crash dumps
+	should be enabled on the target system during the install process.</para>

       <tip><para>Check <filename>/etc/fstab</filename> or
 	&man.swapinfo.8; for a list of swap devices.</para></tip>



From: Warren Block <wblock@wonkity.com>
Subject: Re: docs/159650: Call for review : Description of crash dump (developers-handbook)
Date: Sat, 7 Jan 2012 08:26:33 -0700 (MST)

> On Sat, 7 Jan 2012, Benedict Reuschling wrote:
>
> > Am 07.01.12 09:11, schrieb Ryusuke SUZUKI:
> >> Hello,
> >>
> >> Last year, I took PR/159650. This PR is related to the crash dump.
> >> http://www.freebsd.org/cgi/query-pr.cgi?pr=docs/159650
> >>
> >>
> >> As you know, "dumpdev" variable of rc.conf file is "AUTO" in HEAD,
> >> but changed to "NO" on the stable branches.
> >>
> >> References
> >>  RELENG_9 : http://www.freebsd.org/cgi/cvsweb.cgi/src/etc/defaults/rc.conf#rev1.394.2.2
> >>  RELENG_8 : http://www.freebsd.org/cgi/cvsweb.cgi/src/etc/defaults/rc.conf#rev1.358.2.2
> >>  RELENG_6 : http://www.freebsd.org/cgi/cvsweb.cgi/src/etc/defaults/rc.conf#rev1.252.2.17
> >>
> >>
> >> However, developers-handbook "10.1.1 Configuring the Dump Device" only says
> >>
> >>      "AUTO is the default as of FreeBSD 6.0."
> >>
> >> http://www.freebsd.org/doc/en_US.ISO8859-1/books/developers-handbook/kerneldebug.html#CONFIG-DUMPDEV
> >>
> >>
> >> We should update this sentence.
> >
> > Yes, we should.
> >>
> >> And I also would like to mention the crash dump menu of the bsdinstall,
> >> recently kensmith@ added
> >> http://docs.freebsd.org/cgi/getmsg.cgi?fetch=1485239+0+archive/2011/svn-src-all/20111204.svn-src-all
> >>
> >> Please review the follwoing patch:
> > I've made a few corrections inline below.
> >
> >>
> >> Index: chapter.sgml
> >> ===================================================================
> >> RCS file: /home/ryusuke/work/cvs-doc/doc/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml,v
> >> retrieving revision 1.80
> >> diff -u -r1.80 chapter.sgml
> >> --- chapter.sgml	2 Dec 2010 14:53:45 -0000	1.80
> >> +++ chapter.sgml	7 Jan 2012 06:54:34 -0000
> >> @@ -76,8 +76,13 @@
> >>  	&man.rc.conf.5; to the path of the swap device (the
> >>  	recommended way to extract a kernel dump) or
> >>  	<filename>AUTO</filename> to use the first configured swap
> >> -	device.  <filename>AUTO</filename> is the default as of
> >> -	&os;&nbsp;6.0.</para>
> >> +	device.  The defualt for <varname>dumpdev</varname> is
> > s/defualt/default
> >
> >> +	<filename>AUTO</filename> in HEAD, and changed to
> >> +	<filename>NO</filename> on RELENG_* branches (exceptionally,
> >> +	it leave <filename>AUTO</filename> in RELENG_7).
> > Not sure what you mean by "leave" here, it does not sound right. Did you
> > miss a word? You probably meant something like "... it is set to
> > <filename>AUTO</filename> in RELENG_7.
>
> I think:
>
>    <filename>NO</filename> on RELENG_* branches (except for RELENG_7,
>    which was left set to <filename>AUTO</filename>).
>
> Those <filename> tags maybe ought to be <literal>, I'm not sure.
>
> >> +	On &os;&nbsp;9.0-RELEASE and later versions,
> >> +	<application>bsdinstall</application> will prompt if crash dumps
>
> The "if" can be read two ways.  Suggestion:
>
> <application>bsdinstall</application> will ask whether crash dumps
>
> >> +	should be enabled on the target system during the install process.</para>

----Security_Multipart(Mon_Jan__9_02_39_52_2012_186)--
Content-Type: application/pgp-signature
Content-Transfer-Encoding: 7bit

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (FreeBSD)

iEYEABECAAYFAk8J1OgACgkQG5rRvmPSlyRu6QCg0uHyduMBWNw1eQcV06m4L0Rx
SKwAoKnRNAyibJ+MpNfTblma/q5IimfC
=jdet
-----END PGP SIGNATURE-----

----Security_Multipart(Mon_Jan__9_02_39_52_2012_186)----

Comment 5 dfilter service freebsd_committer

2012-01-20 15:56:14 UTC

ryusuke     2012-01-20 15:56:00 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/developers-handbook/kerneldebug 
                                                          chapter.sgml 
  Log:
  PR: docs/159650
  
  Update the description about the dumpdev variable in rc.conf.
  
  Reported by:    Jeremy Chadwick <freebsd _at_ jdc dot parodius dot com>
  Reviewed by:    bcr, wblock, freebsd-doc
  
  Revision  Changes    Path
  1.81      +8 -3      doc/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"

Comment 6 Ryusuke SUZUKI freebsd_committer

2012-01-20 15:59:37 UTC

State Changed
From-To: open->closed

Committed. Thanks!