[PATCH v2 -next] Documentation: Improve crashkernel= description

[Vivek Goyal]

On Mon, Feb 07, 2011 at 01:30:54PM +0200, Ahmed S. Darwish wrote:
> 
> Had to explore two C code files to make sense of the 'crashkernel='
> kernel parameter values.  Improve the situation.
> 

Did you look at Documentation/kdump/kdump.txt before looking into the
code. I thought kdump.txt explained the meaning of crashkernel= well.

In case if it was not obivious that for further details look into
kdump.txt, I will suggest to add a line asking reader to look into
kdump.txt for more details.

Tough crashkernel= range1:size1[,range2:size2,...][@offset], description
in next line already mentions kdump.txt

This patch looks good to me as it is though.

Acked-by: Vivek Goyal <vgoyal at redhat.com>

Vivek

> 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..5ad9980 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 '@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
> 
> -- 
> Darwish
> http://darwish.07.googlepages.com