v2: Suggestion to use systemctl instead of kdumpctl Add mkdumprd to "SEE ALSO"
v1: Create man page
Dangyi Liu (1): kdumpctl: Add man page for kdumpctl
kdumpctl.8 | 41 +++++++++++++++++++++++++++++++++++++++++ kexec-tools.spec | 2 ++ 2 files changed, 43 insertions(+) create mode 100644 kdumpctl.8
Signed-off-by: Dangyi Liu dliu@redhat.com --- kdumpctl.8 | 41 +++++++++++++++++++++++++++++++++++++++++ kexec-tools.spec | 2 ++ 2 files changed, 43 insertions(+) create mode 100644 kdumpctl.8
diff --git a/kdumpctl.8 b/kdumpctl.8 new file mode 100644 index 0000000..14d714a --- /dev/null +++ b/kdumpctl.8 @@ -0,0 +1,41 @@ +.TH KDUMPCTL 8 2015-07-13 kexec-tools + +.SH NAME +kdumpctl - control interface for kdump + +.SH SYNOPSIS +.B kdumpctl +.I COMMAND + +.SH DESCRIPTION +.B kdumpctl +is used to check or control the kdump service. +In most case, you should use +.B systemctl +to start / stop / enable kdump service instead. However, +.B kdumpctl +provides more details for debug and a helper to setup ssh key authentication. + +.SH COMMANDS +.TP +.I start +Start the service. +.TP +.I stop +Stop the service. +.TP +.I status +Prints the current status of kdump service. +It returns non-zero value if kdump is not operational. +.TP +.I restart +Is equal to +.I start; stop +.TP +.I propagate +Helps to setup key authentication for ssh storage since it's +impossible to use password authentication during kdump. + +.SH "SEE ALSO" +.BR kdump.conf (5), +.BR mkdumprd (8) diff --git a/kexec-tools.spec b/kexec-tools.spec index a2e39f8..5b99c83 100644 --- a/kexec-tools.spec +++ b/kexec-tools.spec @@ -27,6 +27,7 @@ Source22: kdump-dep-generator.sh Source23: kdump-anaconda-addon-005-12-g60fa4c1.tar.gz Source24: kdump-lib-initramfs.sh Source25: kdump.sysconfig.ppc64le +Source26: kdumpctl.8
####################################### # These are sources for mkdumpramfs @@ -159,6 +160,7 @@ install -m 755 %{SOURCE7} $RPM_BUILD_ROOT/sbin/mkdumprd install -m 644 %{SOURCE8} $RPM_BUILD_ROOT%{_sysconfdir}/kdump.conf install -m 644 kexec/kexec.8 $RPM_BUILD_ROOT%{_mandir}/man8/kexec.8 install -m 644 %{SOURCE12} $RPM_BUILD_ROOT%{_mandir}/man8/mkdumprd.8 +install -m 644 %{SOURCE26} $RPM_BUILD_ROOT%{_mandir}/man8/kdumpctl.8 install -m 755 %{SOURCE20} $RPM_BUILD_ROOT%{_prefix}/lib/kdump/kdump-lib.sh install -m 755 %{SOURCE24} $RPM_BUILD_ROOT%{_prefix}/lib/kdump/kdump-lib-initramfs.sh %ifnarch s390x
Hi Dangyi,
It looks almost fine to me. However, a little bit of nitpick...
On 17/08/2015:05:04:23 PM, Dangyi Liu wrote:
Even if its trivial, at least a line about patch is always good to have.
Signed-off-by: Dangyi Liu dliu@redhat.com
kdumpctl.8 | 41 +++++++++++++++++++++++++++++++++++++++++ kexec-tools.spec | 2 ++ 2 files changed, 43 insertions(+) create mode 100644 kdumpctl.8
diff --git a/kdumpctl.8 b/kdumpctl.8 new file mode 100644 index 0000000..14d714a --- /dev/null +++ b/kdumpctl.8 @@ -0,0 +1,41 @@ +.TH KDUMPCTL 8 2015-07-13 kexec-tools
+.SH NAME +kdumpctl - control interface for kdump
+.SH SYNOPSIS +.B kdumpctl +.I COMMAND
+.SH DESCRIPTION +.B kdumpctl +is used to check or control the kdump service. +In most case, you should use
Should be "In most cases"
+.B systemctl +to start / stop / enable kdump service instead. However, +.B kdumpctl +provides more details for debug and a helper to setup ssh key authentication.
+.SH COMMANDS +.TP +.I start +Start the service. +.TP +.I stop +Stop the service. +.TP +.I status +Prints the current status of kdump service. +It returns non-zero value if kdump is not operational. +.TP +.I restart +Is equal to +.I start; stop +.TP +.I propagate +Helps to setup key authentication for ssh storage since it's +impossible to use password authentication during kdump.
+.SH "SEE ALSO" +.BR kdump.conf (5), +.BR mkdumprd (8) diff --git a/kexec-tools.spec b/kexec-tools.spec index a2e39f8..5b99c83 100644 --- a/kexec-tools.spec +++ b/kexec-tools.spec @@ -27,6 +27,7 @@ Source22: kdump-dep-generator.sh Source23: kdump-anaconda-addon-005-12-g60fa4c1.tar.gz Source24: kdump-lib-initramfs.sh Source25: kdump.sysconfig.ppc64le +Source26: kdumpctl.8
####################################### # These are sources for mkdumpramfs @@ -159,6 +160,7 @@ install -m 755 %{SOURCE7} $RPM_BUILD_ROOT/sbin/mkdumprd install -m 644 %{SOURCE8} $RPM_BUILD_ROOT%{_sysconfdir}/kdump.conf install -m 644 kexec/kexec.8 $RPM_BUILD_ROOT%{_mandir}/man8/kexec.8 install -m 644 %{SOURCE12} $RPM_BUILD_ROOT%{_mandir}/man8/mkdumprd.8 +install -m 644 %{SOURCE26} $RPM_BUILD_ROOT%{_mandir}/man8/kdumpctl.8 install -m 755 %{SOURCE20} $RPM_BUILD_ROOT%{_prefix}/lib/kdump/kdump-lib.sh install -m 755 %{SOURCE24} $RPM_BUILD_ROOT%{_prefix}/lib/kdump/kdump-lib-initramfs.sh %ifnarch s390x -- 2.4.3
kexec mailing list kexec@lists.fedoraproject.org https://lists.fedoraproject.org/mailman/listinfo/kexec
Thanks
~Pratyush
Thank you, Pratyush. I'll send the patch again.
Dangyi
On Tue, 2015-08-18 at 09:42 +0530, Pratyush Anand wrote:
Hi Dangyi,
It looks almost fine to me. However, a little bit of nitpick...
On 17/08/2015:05:04:23 PM, Dangyi Liu wrote:
Even if its trivial, at least a line about patch is always good to have.
Signed-off-by: Dangyi Liu dliu@redhat.com
kdumpctl.8 | 41 +++++++++++++++++++++++++++++++++++++++++ kexec-tools.spec | 2 ++ 2 files changed, 43 insertions(+) create mode 100644 kdumpctl.8
diff --git a/kdumpctl.8 b/kdumpctl.8 new file mode 100644 index 0000000..14d714a --- /dev/null +++ b/kdumpctl.8 @@ -0,0 +1,41 @@ +.TH KDUMPCTL 8 2015-07-13 kexec-tools
+.SH NAME +kdumpctl - control interface for kdump
+.SH SYNOPSIS +.B kdumpctl +.I COMMAND
+.SH DESCRIPTION +.B kdumpctl +is used to check or control the kdump service. +In most case, you should use
Should be "In most cases"
+.B systemctl +to start / stop / enable kdump service instead. However, +.B kdumpctl +provides more details for debug and a helper to setup ssh key authentication.
+.SH COMMANDS +.TP +.I start +Start the service. +.TP +.I stop +Stop the service. +.TP +.I status +Prints the current status of kdump service. +It returns non-zero value if kdump is not operational. +.TP +.I restart +Is equal to +.I start; stop +.TP +.I propagate +Helps to setup key authentication for ssh storage since it's +impossible to use password authentication during kdump.
+.SH "SEE ALSO" +.BR kdump.conf (5), +.BR mkdumprd (8) diff --git a/kexec-tools.spec b/kexec-tools.spec index a2e39f8..5b99c83 100644 --- a/kexec-tools.spec +++ b/kexec-tools.spec @@ -27,6 +27,7 @@ Source22: kdump-dep-generator.sh Source23: kdump-anaconda-addon-005-12-g60fa4c1.tar.gz Source24: kdump-lib-initramfs.sh Source25: kdump.sysconfig.ppc64le +Source26: kdumpctl.8
####################################### # These are sources for mkdumpramfs @@ -159,6 +160,7 @@ install -m 755 %{SOURCE7} $RPM_BUILD_ROOT/sbin/mkdumprd install -m 644 %{SOURCE8} $RPM_BUILD_ROOT%{_sysconfdir}/kdump.conf install -m 644 kexec/kexec.8 $RPM_BUILD_ROOT%{_mandir}/man8/kexec.8 install -m 644 %{SOURCE12} $RPM_BUILD_ROOT%{_mandir}/man8/mkdumprd.8 +install -m 644 %{SOURCE26} $RPM_BUILD_ROOT%{_mandir}/man8/kdumpctl.8 install -m 755 %{SOURCE20} $RPM_BUILD_ROOT%{_prefix}/lib/kdump/kdump-lib.sh install -m 755 %{SOURCE24} $RPM_BUILD_ROOT%{_prefix}/lib/kdump/kdump-lib-initramfs.sh %ifnarch s390x
On 17/08/2015:05:04:22 PM, Dangyi Liu wrote:
v2: Suggestion to use systemctl instead of kdumpctl Add mkdumprd to "SEE ALSO"
v1: Create man page
Since, it is a single patch so, probably you do not need a cover-letter. You can put version log in same patch after --- (after Signed-off you will find a line with ---). So, basically you create a patch and then hand edit patch file for version log updates.
Thanks
~Pratyush
-
Dangyi Liu -
Pratyush Anand