Fwd: Re: [PATCH 1/2] kdump.conf comments fixes

[Dave Young]

----- Forwarded message from Donald Berry  -----
> Date: Wed, 22 Jun 2016 13:02:22 -0400 (EDT)
> From: Donald Berry 
> To: [e-mail]
> Cc: [e-mail], [e-mail], [e-mail]
> Subject: Re: [PATCH 1/2] kdump.conf comments fixes
>
> My suggestions for /etc/kdump.conf.
>
> Don
>
> ----- Original Message -----
> From: [e-mail]
> To: [e-mail]
> Cc: [e-mail], [e-mail], [e-mail], "Freeman Zhang" 
> Sent: Wednesday, June 22, 2016 5:22:15 AM
> Subject: [PATCH 1/2] kdump.conf comments fixes
>
> The default action comment about "halt" is wrong, default action means
> the action to perform after a vmcore saving failure.
>
> Also there are lots of typos and incorrect expressions. Fix them here as well.
>
> Signed-off-by: Freeman Zhang 
> Reported-by: Donald Berry 
> Reviewed-by: Dave Young
>
> kdump.conf |   89 ++++++++++++++++++++++++++++---------------------------------
>  1 file changed, 42 insertions(+), 47 deletions(-)
>
> --- kexec-tools.orig/kdump.conf
> +++ kexec-tools/kdump.conf
> @@ -3,14 +3,14 @@
>  # This file contains a series of commands to perform (in order) when a
>  # kernel crash has happened and the kdump kernel has been loaded.  Directives in
>  # this file are only applicable to the kdump initramfs, and have no effect if
> -# the root filesystem is mounted and the normal init scripts are processed
> +# the root filesystem is mounted and the normal init scripts are processed.
>  #
> -# Currently only one dump target and path may be configured at once
> -# if the configured dump target fails, the default action will be preformed
> -# the default action may be configured with the default directive below.  If the
> -# configured dump target succedes 
> +# Currently, only one dump target and path can be specified. If the configured
> +# dump target fails, the default action will be performed. The default action
> +# can be configured with the default directive.
> +#
> +# Supported options:
>  #
> -# Basics commands supported are:
>  # raw <partition>	- Will dd /proc/vmcore into <partition>.
>  #			  Use persistent device names for partition devices,
>  #			  such as /dev/vg/<devname>.
> @@ -21,11 +21,11 @@
>  # ssh 	- Will scp /proc/vmcore to
>  #			  :/var/crash/%HOST-%DATE/, supports DNS
>  #			  NOTE: make sure user has necessary write
> -#			  permissions on server
> +#			  permissions on the server.
>  #
> -# sshkey <path>		- Will use the sshkey to do ssh dump
> -#			  Specifies the path of the ssh key you want to use
> -#			  when do ssh dump, the default value is
> +# sshkey <path>		- Will use the sshkey to do ssh dump.
> +#			  Specifies the path of the ssh key to use
> +#			  when dumping via ssh. The default value is
>  #			  /root/.ssh/kdump_id_rsa.
>
> sshkey <path>
>               Specifies the path of the ssh key to use when dumping via ssh.  The default value is /root/.ssh/kdump_id_rsa.
>
> #
>  # <fs type> <partition> - Will mount -t <fs type> <partition> /mnt and copy
> @@ -50,17 +50,15 @@
>  #
>  # core_collector <command> <options>
>  #			- This allows you to specify the command to copy
> -#			  the vmcore.  You could use the dump filtering
> -#			  program makedumpfile, the default one, to retrieve
> -#			  your core, which on some arches can drastically
> -#			  reduce core file size. See /sbin/makedumpfile --help
> -#			  for a list of options. Note that the -i and -g
> -#			  options are not needed here, as the initrd will
> -#			  automatically be populated with a config file
> -#			  appropriate for the running kernel.
> -#			  Default core_collector for raw/ssh dump is:
> +#			  the vmcore. The default is makedumpfile, which on
> +#			  some architectures can drastically reduce core file size.
> +#			  See /sbin/makedumpfile --help for a list of options.
> +#			  Note that the -i and -g options are not needed here,
> +#			  as the initrd will automatically be populated with a
> +#			  config file appropriate for the running kernel.
> +#			  The default core_collector for raw/ssh dump is:
>  #			  "makedumpfile -F -l --message-level 1 -d 31".
> -#			  Default core_collector for other targets is:
> +#			  The default core_collector for other targets is:
>  #			  "makedumpfile -l --message-level 1 -d 31".
>  #			  For core_collector format details please refer to
>  #			  kexec-kdump-howto.txt or kdump.conf manpage.
> @@ -70,13 +68,13 @@
>  # 			  executable just after the memory dump process
>  # 			  terminates. The exit status from the dump process
>  # 			  is fed to the kdump_post executable, which can be
> -# 			  used to trigger different actions for success or
> -# 			  failure.
> +# 			  used to trigger actions for success or failure
> +# 			  respectively.
>  #
>    core_collector <command> <options>
>           This allows you to specify the command used to copy the vmcore.  The default is makedumpfile, which  on some architectures can drastically reduce
>           core file size.  See /sbin/makedumpfile --help for a list of options.  Note that the -i and -g options are not needed here, as the initrd will
>           automatically be populated with a config file appropriate for the running kernel.
>
>           The default core_collector for raw/ssh dump  is:  "makedumpfile  -F  -l  --message-level  1  -d  31".   The default
>           core_collector  for  other  targets is: "makedumpfile -l --message-level 1 -d 31".
>
>           If  "makedumpfile -F" is used then you will get a flattened format vmcore.flat.  You will need to use "makedumpfile -R" to rearrange the
>           dump data from standard input to a normal dumpfile (readable with analysis tools).  i.e. "makedumpfile -R vmcore < vmcore.flat"
>
> # kdump_pre <binary | script>
> -#			- works just like the kdump_post directive, but instead
> +#			- Works just like the kdump_post directive, but instead
>  #			  of running after the dump process, runs immediately
> -#			  before.  Exit status of this binary is interpreted
> +#			  before. Exit status of this binary is interpreted
>
> Double spaces are correct between a period and the start of the next sentence.
>
> #			  as follows:
>  #			  0 - continue with dump process as usual
>  #			  non 0 - reboot the system
> @@ -94,23 +92,18 @@
>  # 			  initrd, typically used to set up access to
>  # 			  non-boot-path dump targets that might otherwise
>  # 			  not be accessible in the kdump environment. Multiple
> -# 			  modules can be listed, separated by a space, and any
> +# 			  modules can be listed, separated by spaces, and any
>  # 			  dependent modules will automatically be included.
>  #
>  # default <reboot | halt | poweroff | shell | dump_to_rootfs>
> -#			- Action to preform in case dumping to intended target
> -#			  fails. If no default action is specified, "reboot" 
> -#			  is assumed default.
> -#			  reboot: If the default action is reboot simply reboot
> -#				  the system and loose the core that you are
> -#				  trying to retrieve.
> -#			  halt:   If the default action is halt, then simply
> -#				  halt the system after attempting to capture
> -#				  a vmcore, regardless of success or failure.
> -#			  poweroff: The system will be powered down
> -#			  shell:  If the default action is shell, then drop to
> -#				  an shell session inside the initramfs from
> -#				  where you can try to record the core manually.
> +#			- Action to perform in case dumping to intended target
> +#			  fails. The default is "reboot".
> +#			  reboot: Reboot the system and lose the vmcore.
> +#			  halt:   Halt the system and lose the vmcore.
> +#			  poweroff: Power down the system.
> +#			  shell:  Drop to a shell session inside the initramfs,
> +#			  	  then you can try to save the core
> +#			  	  manually.
>  #				  Exiting this shell reboots the system.
>  #				  Note: kdump uses bash as the default shell.
>  #			  dump_to_rootfs: If non-root dump target is specified,
> @@ -119,15 +112,16 @@
>  #				  to rootfs from initramfs context and reboot. 
>  #
>    default <reboot | halt | poweroff | shell | dump_to_rootfs>
>           Action  to  perform  in  case  dumping  to the intended target fails.  The default is "reboot".
>           reboot: reboot the system (this is what most people will want, as it returns the system to a nominal state).
>           shell: drop to a shell session inside the initramfs, from which you can try to save the core manually.  Exiting this shell reboots the system.
>                  Note: kdump uses bash as the default shell.
>           halt: bring the system to a halt, requiring manual reset.
>           poweroff:  The  system  will  be  powered  down.
>           dump_to_rootfs: the specified root will be mounted and the dump will be saved in the "path" directory.
>
> # force_rebuild <0 | 1>
> -#			- By default, kdump initrd only will be rebuilt when
> +#			- By default, kdump initrd will only be rebuilt when
>  #			  necessary. Specify 1 to force rebuilding kdump
>  #			  initrd every time when kdump service starts.
>  #
> -#override_resettable <0 | 1>
> -#			- Usually a unresettable block device can't be dump target.
> -#			Specifying 1 means though block target is unresettable, user
> -#			understand this situation and want to try dumping. By default,
> -#			it's set to 0, means not to try a destined failure.
> +# override_resettable <0 | 1>
> +#			- Usually an unresettable block device can't be a dump
> +#			  target. Specifying 1 means that even though the block
> +#			  target is unresettable, the user wants to try dumping
> +#			  anyway. By default, it's set to 0, which will not try
> +#			  something destined to fail.
>  #
>  # dracut_args <arg(s)>
>  #			- Pass extra dracut options when rebuilding kdump
> @@ -135,11 +129,12 @@
>  #
>  # fence_kdump_args <arg(s)>
>  #			- Command line arguments for fence_kdump_send (it can contain
> -#			all valid arguments except hosts to send notification to).
> +#			  all valid arguments except hosts to send notification to).
>  #
>  # fence_kdump_nodes <node(s)>
> -# 			- List of cluster node(s) separated by space to send fence_kdump
> -# 			notification to (this option is mandatory to enable fence_kdump).
> +# 			- List of cluster node(s), separated by spaces, to send
> +# 			  fence_kdump notifications to (this option is mandatory to
> +# 			  enable fence_kdump).
>  #
>
> #raw /dev/vg/lv_kdump

----- End forwarded message -----