[PATCH -next] Documentation: Improve crashkernel= description

[Randy Dunlap]

On Mon, 7 Feb 2011 06:57:33 +0900 Simon Horman wrote:

> On Sun, Feb 06, 2011 at 05:41:08PM +0200, Ahmed S. Darwish wrote:
> > (Also applicable over 2.6.38-rc3)
> > 
> > Had to explore two C code files to make sense of the 'crashkernel='
> > kernel parameter values.  Improve the situation.
> > 
> > Signed-off-by: Ahmed S. Darwish <darwish.07 at gmail.com>
> > ---
> > 
> > diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
> > index 89835a4..8f26b42 100644
> > --- a/Documentation/kernel-parameters.txt
> > +++ b/Documentation/kernel-parameters.txt
> > @@ -545,9 +545,12 @@ and is between 256 and 4096 characters. It is defined in the file
> >  			Format:
> >  			<first_slot>,<last_slot>,<port>,<enum_bit>[,<debug>]
> >  
> > -	crashkernel=nn[KMG]@ss[KMG]
> > -			[KNL] Reserve a chunk of physical memory to
> > -			hold a kernel to switch to with kexec on panic.
> > +	crashkernel=size[KMG][@offset[KMG]]
> > +			[KNL] Using kexec, Linux can switch to a 'crash kernel'
> > +			upon panic. This parameter reserves the physical
> > +			memory region [offset, offset + size] for that kernel
> > +			image. If the '@offset' part was ignored, Linux finds
> > +			a suitable crash image start address automatically.
> 
> I think this would be further improved as:
> 
> 			... If '@offset' is omitted then a suitable
> 			offset is selected automatically.
> 
> >  
> >  	crashkernel=range1:size1[,range2:size2,...][@offset]
> >  			[KNL] Same as above, but depends on the memory

Hi,

I also prefer Simon's change.  Can you please resend an updated patch?

thanks,
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***