Re: [PATCH] documentation fix

There are lots of typos and incorrect expressions in kdump.conf, as well as its manpage kdump.conf.5. Fix them to make it less confusing. Signed-off-by: Freeman Zhang <zhezhang(a)redhat.com&gt; Reported-by: Donald Berry <dberry(a)redhat.com&gt; --- kdump.conf | 73 +++++++++++++++++++++++++++++----------------------------- kdump.conf.5 | 75 ++++++++++++++++++++++++++---------------------------------- 2 files changed, 70 insertions(+), 78 deletions(-) diff --git a/kdump.conf b/kdump.conf index 54b581d..09716d7 100644 --- a/kdump.conf +++ b/kdump.conf @@ -1,16 +1,16 @@ -# Configures where to put the kdump /proc/vmcore files +# Configure where&how to save the kdump /proc/vmcore files # # 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 +# this file are only applicable to the kdump initramfs, and show no effect if

# 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 at a time. +# If the configured dump target fails, the default action will be performed. +# The default action may be configured with the default directive. +# +# Basic commands supported are: # -# Basics commands supported are: # raw <partition> - Will dd /proc/vmcore into <partition>. # Use persistent device names for partition devices, # such as /dev/vg/<devname>. @@ -23,9 +23,9 @@ # NOTE: make sure user has necessary write # permissions on 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. +# Specify the path of the ssh key you want 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 @@ -58,9 +58,9 @@ # 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 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,14 +70,14 @@ # 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. # # kdump_pre <binary | script> -# - 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 -# as follows: +# - Works just like the kdump_post directive, but instead +# of running after the dump process, the executable runs +# right before the dumping. Exit status of the execution +# is interpreted as follows: # 0 - continue with dump process as usual # non 0 - reboot the system # @@ -90,28 +90,27 @@ # # extra_modules <module(s)> # - This directive allows you to specify extra kernel -# modules that you want to be loaded in the kdump +# modules that you wish to be loaded in the kdump # 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 +# - Action to perform 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 +# the system and drop 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. +# halt the system after 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. -# Exiting this shell reboots the system. +# a shell session inside the initramfs from +# where you can try to save the core manually. +# Then exit this shell to reboot the system. # Note: kdump uses bash as the default shell. # dump_to_rootfs: If non-root dump target is specified, # the default action can be set as dump_to_rootfs. @@ -119,15 +118,16 @@ # to rootfs from initramfs context and reboot. # # 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 failure. # # dracut_args <arg(s)> # - Pass extra dracut options when rebuilding kdump @@ -135,11 +135,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 diff --git a/kdump.conf.5 b/kdump.conf.5 index f1c2a2c..5eabad7 100644 --- a/kdump.conf.5 +++ b/kdump.conf.5 @@ -11,13 +11,13 @@ collection service. kdump.conf provides post-kexec instructions to the kdump kernel. It is stored in the initrd file managed by the kdump service. If you change this file and do not want to restart before it takes effect, restart

-the kdump service to rebuild to initrd. +the kdump service to rebuild the initrd.

For most configurations, you can simply review the examples provided in the stock /etc/kdump.conf. .B NOTE: -For filesystem dump the dump target must be mounted before building +For filesystem dumps the dump target must be mounted before building kdump initramfs. kdump.conf only affects the behavior of the initramfs. Please read the @@ -48,8 +48,8 @@ server and that a fqdn is used as the server name .B sshkey <path> .RS -Specifies the path of the ssh key you want to use when do ssh dump, -the default value is /root/.ssh/kdump_id_rsa. +Specifies the path of the ssh key you want to use when dumping via ssh. +The default value is /root/.ssh/kdump_id_rsa. .RE .B <fs type> <partition> @@ -77,26 +77,20 @@ Ignored for raw device dumps. If unset, will default to /var/crash. .B core_collector <command> <options> .RS 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. +The default is makedumpfile, which can drastically reduce core file size on +some architectures. 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. +will automatically be populated with a config file appropriate for the +running kernel. .PP -Note 1: About default core collector: -Default core_collector for raw/ssh dump is: +Note 1: 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". -Even if core_collector option is commented out in kdump.conf, makedumpfile -is default core collector and kdump uses it internally. -If one does not want makedumpfile as default core_collector, then they -need to specify one using core_collector option to change the behavior. .PP Note 2: 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 stdard input to a normal dumpfile (readable with analysis +dump data from standard input to a normal dumpfile (readable with analysis tools). ie. "makedumpfile -R vmcore < vmcore.flat" @@ -108,26 +102,25 @@ This directive allows you to run a specified 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 repectively. .PP Note that scripts written for use with this -directive must use the /bin/bash interpreter +directive must use the /bin/bash interpreter. .RE .B kdump_pre <binary | script> .RS 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 -as follows: +of running after the dump process, the specified executable +runs right before dumping. Exit status of the execution is +interpreted as follows: .PP 0 - continue with dump process as usual .PP non 0 - reboot the system .PP Note that scripts written for this directive must use -the /bin/bash interpreter +the /bin/bash interpreter. .RE .B extra_bins <binaries | shell scripts> @@ -142,22 +135,22 @@ relies on other binaries or scripts. .B extra_modules <module(s)> .RS This directive allows you to specify extra kernel -modules that you want to be loaded in the kdump +modules that you wish to be loaded in the kdump 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. .RE .B default <reboot | halt | poweroff | shell | dump_to_rootfs>

.RS -Action to preform in case dumping to intended target fails. If no default +Action to perform 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 (this is what most people will want, as it returns the system to a nominal state). shell: If the default -action is shell, then drop to an shell session inside the initramfs from -where you can manually preform additional recovery actions. Exiting this shell +action is shell, then drop to a shell session inside the initramfs from +where you can manually perform additional recovery actions. Exiting this shell reboots the system. halt: bring the system to a halt, requiring manual reset poweroff: The system will be powered down. dump_to_rootfs:If the default action is dump_to_rootfs, specified root will be mounted and dump will be saved in "path" @@ -167,15 +160,15 @@ Note: kdump uses bash as the default shell. .B force_rebuild <0 | 1> .RS -By default, kdump initrd only will be rebuilt when necessary. +By default, kdump initrd will only be rebuilt when necessary. Specify 1 to force rebuilding kdump initrd every time when kdump service starts. .RE .B override_resettable <0 | 1> .RS -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. +Usually an unresettable block device can't be dump target. Specifying 1 means +that even though block target is unresettable, user wants to try dumping anyway. +By default, it's set to 0, which will not try something destined to failure. .RE @@ -195,7 +188,7 @@ arguments except hosts to send notification to). .B fence_kdump_nodes <node(s)> .RS -List of cluster node(s) separated by space to send fence_kdump notification +List of cluster node(s), separated by spaces, to send fence_kdump notification to (this option is mandatory to enable fence_kdump). .RE @@ -210,25 +203,23 @@ directly. .B options <module> <option list> .RS -Use KDUMP_COMMANDLINE_APPEND in /etc/sysconfig/kdump to add proper -module option as kernel command line params. Such as append loop.max_loop=1 -to limit maximum loop devices to 1. +Use KDUMP_COMMANDLINE_APPEND in /etc/sysconfig/kdump to add module options as kernel command line parameters. For example, specify 'append loop.max_loop=1' to limit maximum loop devices to 1. .RE .B link_delay <seconds> .RS -link_delay was used to wait a network device to initialize before using it. +link_delay was used to wait for a network device to initialize before using it. Now dracut network module take care of this issue automaticlly. .RE .B disk_timeout <seconds> .RS -Similar to link_delay, dracut ensures disks being ready before kdump uses them. +Similar to link_delay, dracut ensures disks are ready before kdump uses them. .RE .B debug_mem_level <0-3> .RS -This was used to turns on debug/verbose output of kdump scripts regarding +This was used to turn on debug/verbose output of kdump scripts regarding free/used memory at various points of execution. This feature has been moved to dracut now. Use KDUMP_COMMANDLINE_APPEND in /etc/sysconfig/kdump and @@ -253,7 +244,7 @@ present in initramfs but it is not actually loaded in kernel. Hence retaining blacklist option creates more confusing behavior. It has been deprecated. .PP -Instead use rd.driver.blacklist option on second kernel to blacklist +Instead, use rd.driver.blacklist option on second kernel to blacklist a certain module. One can edit /etc/sysconfig/kdump.conf and edit KDUMP_COMMANDLINE_APPEND to pass kernel command line options. Refer to dracut.cmdline man page for more details on module blacklist option. @@ -262,7 +253,7 @@ to dracut.cmdline man page for more details on module blacklist option. .RE .SH EXAMPLES -Here is some examples for core_collector option: +Here are some examples for core_collector option: .PP Core collector command format depends on dump target type. Typically for filesystem (local/remote), core_collector should accept two arguments. -- 2.5.5 _______________________________________________ kexec mailing list kexec(a)lists.fedoraproject.org https://lists.fedoraproject.org/admin/lists/kexec@lists.fedoraproject.org