Don,
Since you brought up the issue, could you help to review the patch?
On 05/27/16 at 04:23pm, Freeman Zhang wrote:
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>
Reported-by: Donald Berry <dberry(a)redhat.com>
---
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
The main purpose is *where* though it also has *how*, I would say keep original
sentence is better.
#
# 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
I do not know what is the benefit change have to show
# 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.
Agree about the comma and once/a time, but what is the benefit to change
configured to specified?
Change the sentence to below sounds better:
Use only one dump target and one path.
+#
+# Basic commands supported are:
#
-# Basics commands supported are:
Supported options:
# 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
Drop the "that ..." part should be fine.
extra kernel modules, typecally ...
# 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
I think original sensence means "lose" instead of "drop"
# 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 shello to reboot the system.
Existing this shell reboots the system is fine, the previous two line changes
are good
Sorry, I do not get enough time today, will review the remain part later.
Thanks
Dave