Bug 50790

Summary:

[patch] Expand description of dumpdev use in Developers Handbook

Product:

Documentation

Reporter:

simon <simon>

Component:

Books & Articles

Assignee:

freebsd-doc (Nobody) <doc>

Status:

Closed FIXED

Severity:

Affects Only Me

Priority:

Normal

Version:

Latest

Hardware:

Any

OS:

Any

Attachments:

Description	Flags
doc-develbook-crashdump.patch	none

Description simon 2003-04-10 19:40:06 UTC

Document that setting dumpdev in rc.conf also automatically calls
savecore on boot.

Change a reference to /etc/rc.conf to use rc.conf(5) instead.

Comment 1 Chris Pepper 2003-04-11 17:01:44 UTC

At 8:35 PM +0200 2003/04/10, Simon L.Nielsen wrote:
>  >Number:         50790
>>Category:       docs
>  >Synopsis:       [patch] Expand description of dumpdev use in Developers
>
>--- doc-develbook-crashdump.patch begins here ---
>Index: kerneldebug/chapter.sgml
>===================================================================
>RCS file: 
>/home/ncvs/doc/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml,v
>retrieving revision 1.45
>diff -u -d -r1.45 chapter.sgml
>--- kerneldebug/chapter.sgml	12 Jan 2003 18:31:39 -0000	1.45
>+++ kerneldebug/chapter.sgml	10 Apr 2003 18:23:14 -0000
>@@ -24,7 +24,12 @@
>  	(note that this will have to be done after configuring the partition in
>  	question as swap space via &man.swapon.8;).  This is normally arranged
>  	by setting the <varname>dumpdev</varname> variable in
>-	<filename>/etc/rc.conf</filename>.</para>
>+	&man.rc.conf.5;.  If you have set <varname>dumpdev</varname> variable

	s/set <varname>dumpdev</varname> variable/
	  set the <varname>dumpdev</varname> variable/
or	s/set <varname>dumpdev</varname> variable/
	  set <varname>dumpdev</varname>/

>+	in &man.rc.conf.5; the &man.savecore.8; program will automatically be
>+	called on the first multi-user boot after the crash and save the kernel
>+	crash dump to the directory specified in the &man.rc.conf.5;
>+	<varname>dumpdir</varname> variable (the default directory is
>+	<filename>/var/crash</filename>).</para>

-- 
Chris Pepper:               <http://www.reppep.com/~pepper/>
Rockefeller University:     <http://www.rockefeller.edu/>

Comment 2 simon 2003-04-14 11:05:22 UTC

On 2003.04.11 12:01:44 -0400, Chris Pepper wrote:
> At 8:35 PM +0200 2003/04/10, Simon L.Nielsen wrote:
> > 	by setting the <varname>dumpdev</varname> variable in
> >-	<filename>/etc/rc.conf</filename>.</para>
> >+	&man.rc.conf.5;.  If you have set <varname>dumpdev</varname> variable
> 
> 	s/set <varname>dumpdev</varname> variable/
> 	  set the <varname>dumpdev</varname> variable/
> or	s/set <varname>dumpdev</varname> variable/
> 	  set <varname>dumpdev</varname>/


Seems right. I don't really know which is best so I hope a native
english speaker can decide which is preferable.

Thanks for looking at it.

-- 
Simon L. Nielsen

Comment 3 Murray Stokely freebsd_committer

2003-05-05 04:40:03 UTC

State Changed
From-To: open->closed

I've committed an update to this paragraph that takes into account 
your original change and Chris' improvement.  One thing to note is 
that it doesn't look good to use the man page entities twice in close 
proximity.  So I used &man.dumpon.8; the first time, then just used 
<command>dumpon</command> elsewhere in the paragraph. 

This chapter needs a lot of work, so if you can make any more 
extensive grammar improvements throughout this chapter it would be 
much appreciated.  Thanks.