docs/159650: Call for review : Description of crash dump (developers-handbook)

[Warren Block]

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; 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; 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>