[PATCH] kexec: update manpage with explicit mention of clean kexec

[PATCH] kexec: update manpage with explicit mention of clean kexec

[Hari Bathini]

While the manpage does mention about kexec boot with a clean shutdown,
it is not explicit about it. Make it explicit.

Signed-off-by: Hari Bathini <hbathini@linux.ibm.com>
---
 kexec/kexec.8 | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/kexec/kexec.8 b/kexec/kexec.8
index 3a344c5..87e4ab5 100644
--- a/kexec/kexec.8
+++ b/kexec/kexec.8
@@ -95,8 +95,16 @@ then you would use the following command to load the kernel:
 .RB "\-\-append=" "root=/dev/hda1" "\ \-\-initrd=" /boot/initrd
 .RE
 .PP
-After this kernel is loaded, it can be booted to at any time using the
-command:
+After this kernel is loaded, assuming your Linux distribution supports
+kexec-based rebooting, it can be booted to, with a clean shutdown, using
+the command:
+
+.RS
+.BR reboot
+.RE
+.PP
+Alternatively, it can also be booted to, without calling shutdown(8), with
+the command:
 
 .RS
 .BR kexec \ \-e
-- 
2.41.0


_______________________________________________
kexec mailing list
kexec@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/kexec

Re: [PATCH] kexec: update manpage with explicit mention of clean kexec

[Hari Bathini]

Any comments on this, please..

On 07/07/23 10:59 am, Hari Bathini wrote:
> While the manpage does mention about kexec boot with a clean shutdown,
> it is not explicit about it. Make it explicit.
> 
> Signed-off-by: Hari Bathini <hbathini@linux.ibm.com>
> ---
>   kexec/kexec.8 | 12 ++++++++++--
>   1 file changed, 10 insertions(+), 2 deletions(-)
> 
> diff --git a/kexec/kexec.8 b/kexec/kexec.8
> index 3a344c5..87e4ab5 100644
> --- a/kexec/kexec.8
> +++ b/kexec/kexec.8
> @@ -95,8 +95,16 @@ then you would use the following command to load the kernel:
>   .RB "\-\-append=" "root=/dev/hda1" "\ \-\-initrd=" /boot/initrd
>   .RE
>   .PP
> -After this kernel is loaded, it can be booted to at any time using the
> -command:
> +After this kernel is loaded, assuming your Linux distribution supports
> +kexec-based rebooting, it can be booted to, with a clean shutdown, using
> +the command:
> +
> +.RS
> +.BR reboot
> +.RE
> +.PP
> +Alternatively, it can also be booted to, without calling shutdown(8), with
> +the command:
> 
>   .RS
>   .BR kexec \ \-e

_______________________________________________
kexec mailing list
kexec@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/kexec

Re: [PATCH] kexec: update manpage with explicit mention of clean kexec

[Simon Horman]

On Mon, Aug 28, 2023 at 11:46:14AM +0530, Hari Bathini wrote:
> Any comments on this, please..

Hi Hari,

Sorry, I had missed this.

> On 07/07/23 10:59 am, Hari Bathini wrote:
> > While the manpage does mention about kexec boot with a clean shutdown,
> > it is not explicit about it. Make it explicit.
> > 
> > Signed-off-by: Hari Bathini <hbathini@linux.ibm.com>
> > ---
> >   kexec/kexec.8 | 12 ++++++++++--
> >   1 file changed, 10 insertions(+), 2 deletions(-)
> > 
> > diff --git a/kexec/kexec.8 b/kexec/kexec.8
> > index 3a344c5..87e4ab5 100644
> > --- a/kexec/kexec.8
> > +++ b/kexec/kexec.8
> > @@ -95,8 +95,16 @@ then you would use the following command to load the kernel:
> >   .RB "\-\-append=" "root=/dev/hda1" "\ \-\-initrd=" /boot/initrd
> >   .RE
> >   .PP
> > -After this kernel is loaded, it can be booted to at any time using the
> > -command:
> > +After this kernel is loaded, assuming your Linux distribution supports
> > +kexec-based rebooting, it can be booted to, with a clean shutdown, using
> > +the command:

Perhaps user-space would be better than "your Linux distribution".
But perhaps that is just kernel developer speak and makes less
sense to others.

> > +
> > +.RS
> > +.BR reboot
> > +.RE
> > +.PP
> > +Alternatively, it can also be booted to, without calling shutdown(8), with
> > +the command:
> > 
> >   .RS
> >   .BR kexec \ \-e
> 

_______________________________________________
kexec mailing list
kexec@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/kexec

Re: [PATCH] kexec: update manpage with explicit mention of clean kexec

[Baoquan He]

On 08/28/23 at 09:48am, Simon Horman wrote:
> On Mon, Aug 28, 2023 at 11:46:14AM +0530, Hari Bathini wrote:
> > Any comments on this, please..
> 
> Hi Hari,
> 
> Sorry, I had missed this.
> 
> > On 07/07/23 10:59 am, Hari Bathini wrote:
> > > While the manpage does mention about kexec boot with a clean shutdown,
> > > it is not explicit about it. Make it explicit.
> > > 
> > > Signed-off-by: Hari Bathini <hbathini@linux.ibm.com>
> > > ---
> > >   kexec/kexec.8 | 12 ++++++++++--
> > >   1 file changed, 10 insertions(+), 2 deletions(-)
> > > 
> > > diff --git a/kexec/kexec.8 b/kexec/kexec.8
> > > index 3a344c5..87e4ab5 100644
> > > --- a/kexec/kexec.8
> > > +++ b/kexec/kexec.8
> > > @@ -95,8 +95,16 @@ then you would use the following command to load the kernel:
> > >   .RB "\-\-append=" "root=/dev/hda1" "\ \-\-initrd=" /boot/initrd
> > >   .RE
> > >   .PP
> > > -After this kernel is loaded, it can be booted to at any time using the
> > > -command:
> > > +After this kernel is loaded, assuming your Linux distribution supports
> > > +kexec-based rebooting, it can be booted to, with a clean shutdown, using
> > > +the command:
> 
> Perhaps user-space would be better than "your Linux distribution".
> But perhaps that is just kernel developer speak and makes less
> sense to others.

Agree, linux distrobution doesn't make sense here. And since this is a
kexec man page, does it really need to make this change? We know
kexec-tools loaded a kernel, we will use kexec-tools to trigger the
reboot. Wondering why we need to stress distros or kernel or kexec-tools
supports the kexec-based rebooting. 'with a clean shutdown' seems a
little helpful though.

> 
> > > +
> > > +.RS
> > > +.BR reboot
> > > +.RE
> > > +.PP
> > > +Alternatively, it can also be booted to, without calling shutdown(8), with
> > > +the command:
> > > 
> > >   .RS
> > >   .BR kexec \ \-e
> > 
> 
> _______________________________________________
> kexec mailing list
> kexec@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/kexec
> 


_______________________________________________
kexec mailing list
kexec@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/kexec

Re: [PATCH] kexec: update manpage with explicit mention of clean kexec

[Hari Bathini]

On 28/08/23 1:18 pm, Simon Horman wrote:
> On Mon, Aug 28, 2023 at 11:46:14AM +0530, Hari Bathini wrote:
>> Any comments on this, please..
> 
> Hi Hari,
> 
> Sorry, I had missed this.

No worries. Thanks for the response.

> 
>> On 07/07/23 10:59 am, Hari Bathini wrote:
>>> While the manpage does mention about kexec boot with a clean shutdown,
>>> it is not explicit about it. Make it explicit.
>>>
>>> Signed-off-by: Hari Bathini <hbathini@linux.ibm.com>
>>> ---
>>>    kexec/kexec.8 | 12 ++++++++++--
>>>    1 file changed, 10 insertions(+), 2 deletions(-)
>>>
>>> diff --git a/kexec/kexec.8 b/kexec/kexec.8
>>> index 3a344c5..87e4ab5 100644
>>> --- a/kexec/kexec.8
>>> +++ b/kexec/kexec.8
>>> @@ -95,8 +95,16 @@ then you would use the following command to load the kernel:
>>>    .RB "\-\-append=" "root=/dev/hda1" "\ \-\-initrd=" /boot/initrd
>>>    .RE
>>>    .PP
>>> -After this kernel is loaded, it can be booted to at any time using the
>>> -command:
>>> +After this kernel is loaded, assuming your Linux distribution supports
>>> +kexec-based rebooting, it can be booted to, with a clean shutdown, using
>>> +the command:
> 
> Perhaps user-space would be better than "your Linux distribution".
> But perhaps that is just kernel developer speak and makes less
> sense to others.

No strong inclination to putting it either way. Would leave it to you :)

- Hari

_______________________________________________
kexec mailing list
kexec@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/kexec

Re: [PATCH] kexec: update manpage with explicit mention of clean kexec

[Hari Bathini]

On 28/08/23 3:12 pm, Baoquan He wrote:
> On 08/28/23 at 09:48am, Simon Horman wrote:
>> On Mon, Aug 28, 2023 at 11:46:14AM +0530, Hari Bathini wrote:
>>> Any comments on this, please..
>>
>> Hi Hari,
>>
>> Sorry, I had missed this.
>>
>>> On 07/07/23 10:59 am, Hari Bathini wrote:
>>>> While the manpage does mention about kexec boot with a clean shutdown,
>>>> it is not explicit about it. Make it explicit.
>>>>
>>>> Signed-off-by: Hari Bathini <hbathini@linux.ibm.com>
>>>> ---
>>>>    kexec/kexec.8 | 12 ++++++++++--
>>>>    1 file changed, 10 insertions(+), 2 deletions(-)
>>>>
>>>> diff --git a/kexec/kexec.8 b/kexec/kexec.8
>>>> index 3a344c5..87e4ab5 100644
>>>> --- a/kexec/kexec.8
>>>> +++ b/kexec/kexec.8
>>>> @@ -95,8 +95,16 @@ then you would use the following command to load the kernel:
>>>>    .RB "\-\-append=" "root=/dev/hda1" "\ \-\-initrd=" /boot/initrd
>>>>    .RE
>>>>    .PP
>>>> -After this kernel is loaded, it can be booted to at any time using the
>>>> -command:
>>>> +After this kernel is loaded, assuming your Linux distribution supports
>>>> +kexec-based rebooting, it can be booted to, with a clean shutdown, using
>>>> +the command:
>>
>> Perhaps user-space would be better than "your Linux distribution".
>> But perhaps that is just kernel developer speak and makes less
>> sense to others.
> 
> Agree, linux distrobution doesn't make sense here. And since this is a
> kexec man page, does it really need to make this change? We know
> kexec-tools loaded a kernel, we will use kexec-tools to trigger the
> reboot. Wondering why we need to stress distros or kernel or kexec-tools
> supports the kexec-based rebooting. 'with a clean shutdown' seems a
> little helpful though.

Yeah. Users did express that lack of clarity on what is the cleaner
approach to use kexec boot after load. That prompted this patch.
I am ok with "user-space" or "your linux distribution".

Simon, do you want to respin with "user-space" change instead?

Thanks
Hari

_______________________________________________
kexec mailing list
kexec@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/kexec

Re: [PATCH] kexec: update manpage with explicit mention of clean kexec

[Simon Horman]

On Mon, Sep 11, 2023 at 12:04:08PM +0530, Hari Bathini wrote:
> 
> 
> On 28/08/23 3:12 pm, Baoquan He wrote:
> > On 08/28/23 at 09:48am, Simon Horman wrote:
> > > On Mon, Aug 28, 2023 at 11:46:14AM +0530, Hari Bathini wrote:
> > > > Any comments on this, please..
> > > 
> > > Hi Hari,
> > > 
> > > Sorry, I had missed this.
> > > 
> > > > On 07/07/23 10:59 am, Hari Bathini wrote:
> > > > > While the manpage does mention about kexec boot with a clean shutdown,
> > > > > it is not explicit about it. Make it explicit.
> > > > > 
> > > > > Signed-off-by: Hari Bathini <hbathini@linux.ibm.com>
> > > > > ---
> > > > >    kexec/kexec.8 | 12 ++++++++++--
> > > > >    1 file changed, 10 insertions(+), 2 deletions(-)
> > > > > 
> > > > > diff --git a/kexec/kexec.8 b/kexec/kexec.8
> > > > > index 3a344c5..87e4ab5 100644
> > > > > --- a/kexec/kexec.8
> > > > > +++ b/kexec/kexec.8
> > > > > @@ -95,8 +95,16 @@ then you would use the following command to load the kernel:
> > > > >    .RB "\-\-append=" "root=/dev/hda1" "\ \-\-initrd=" /boot/initrd
> > > > >    .RE
> > > > >    .PP
> > > > > -After this kernel is loaded, it can be booted to at any time using the
> > > > > -command:
> > > > > +After this kernel is loaded, assuming your Linux distribution supports
> > > > > +kexec-based rebooting, it can be booted to, with a clean shutdown, using
> > > > > +the command:
> > > 
> > > Perhaps user-space would be better than "your Linux distribution".
> > > But perhaps that is just kernel developer speak and makes less
> > > sense to others.
> > 
> > Agree, linux distrobution doesn't make sense here. And since this is a
> > kexec man page, does it really need to make this change? We know
> > kexec-tools loaded a kernel, we will use kexec-tools to trigger the
> > reboot. Wondering why we need to stress distros or kernel or kexec-tools
> > supports the kexec-based rebooting. 'with a clean shutdown' seems a
> > little helpful though.
> 
> Yeah. Users did express that lack of clarity on what is the cleaner
> approach to use kexec boot after load. That prompted this patch.
> I am ok with "user-space" or "your linux distribution".
> 
> Simon, do you want to respin with "user-space" change instead?

Yes, I think that would be best.

_______________________________________________
kexec mailing list
kexec@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/kexec

Re: [PATCH] kexec: update manpage with explicit mention of clean kexec

[Hari Bathini]

On 20/09/23 5:11 pm, Simon Horman wrote:
> On Mon, Sep 11, 2023 at 12:04:08PM +0530, Hari Bathini wrote:
>>
>>
>> On 28/08/23 3:12 pm, Baoquan He wrote:
>>> On 08/28/23 at 09:48am, Simon Horman wrote:
>>>> On Mon, Aug 28, 2023 at 11:46:14AM +0530, Hari Bathini wrote:
>>>>> Any comments on this, please..
>>>>
>>>> Hi Hari,
>>>>
>>>> Sorry, I had missed this.
>>>>
>>>>> On 07/07/23 10:59 am, Hari Bathini wrote:
>>>>>> While the manpage does mention about kexec boot with a clean shutdown,
>>>>>> it is not explicit about it. Make it explicit.
>>>>>>
>>>>>> Signed-off-by: Hari Bathini <hbathini@linux.ibm.com>
>>>>>> ---
>>>>>>     kexec/kexec.8 | 12 ++++++++++--
>>>>>>     1 file changed, 10 insertions(+), 2 deletions(-)
>>>>>>
>>>>>> diff --git a/kexec/kexec.8 b/kexec/kexec.8
>>>>>> index 3a344c5..87e4ab5 100644
>>>>>> --- a/kexec/kexec.8
>>>>>> +++ b/kexec/kexec.8
>>>>>> @@ -95,8 +95,16 @@ then you would use the following command to load the kernel:
>>>>>>     .RB "\-\-append=" "root=/dev/hda1" "\ \-\-initrd=" /boot/initrd
>>>>>>     .RE
>>>>>>     .PP
>>>>>> -After this kernel is loaded, it can be booted to at any time using the
>>>>>> -command:
>>>>>> +After this kernel is loaded, assuming your Linux distribution supports
>>>>>> +kexec-based rebooting, it can be booted to, with a clean shutdown, using
>>>>>> +the command:
>>>>
>>>> Perhaps user-space would be better than "your Linux distribution".
>>>> But perhaps that is just kernel developer speak and makes less
>>>> sense to others.
>>>
>>> Agree, linux distrobution doesn't make sense here. And since this is a
>>> kexec man page, does it really need to make this change? We know
>>> kexec-tools loaded a kernel, we will use kexec-tools to trigger the
>>> reboot. Wondering why we need to stress distros or kernel or kexec-tools
>>> supports the kexec-based rebooting. 'with a clean shutdown' seems a
>>> little helpful though.
>>
>> Yeah. Users did express that lack of clarity on what is the cleaner
>> approach to use kexec boot after load. That prompted this patch.
>> I am ok with "user-space" or "your linux distribution".
>>
>> Simon, do you want to respin with "user-space" change instead?
> 
> Yes, I think that would be best.

Sure, Simon.
Sent v2.

Thanks
Hari

_______________________________________________
kexec mailing list
kexec@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/kexec