[PATCH v2 3/3] doc/hotplug: update man and --help

[Hari Bathini]

On 14/06/24 12:37 am, Sourabh Jain wrote:
> Update the man page and --help option to make the description of the
> --hotplug option easier to understand.
> 
> Cc: Aditya Gupta <adityag at linux.ibm.com>
> Cc: Baoquan He <bhe at redhat.com>
> Cc: Coiby Xu <coxu at redhat.com>
> Cc: Hari Bathini <hbathini at linux.ibm.com>
> Cc: Mahesh Salgaonkar <mahesh at linux.ibm.com>
> Cc: Simon Horman <horms at kernel.org>

Minor nits below...

Otherwise, looks good.

Acked-by: Hari Bathini <hbathini at linux.ibm.com>

> Signed-off-by: Sourabh Jain <sourabhjain at linux.ibm.com>
> ---
> 
> Changelog:
> 
> Since v1:
>    - Updated --hotplug option description
> 
> ---
>   kexec/kexec.8 | 8 ++++----
>   kexec/kexec.c | 4 +++-
>   2 files changed, 7 insertions(+), 5 deletions(-)
> 
> diff --git a/kexec/kexec.8 b/kexec/kexec.8
> index 9e995fe..92fa3d5 100644
> --- a/kexec/kexec.8
> +++ b/kexec/kexec.8
> @@ -140,10 +140,10 @@ Open a help file for
>   .BR kexec .
>   .TP
>   .B \-\-hotplug
> -Setup for kernel modification of the elfcorehdr. This option performs
> -the steps needed to support kernel updates to the elfcorehdr in the
> -presence of hot un/plug and/or on/offline events. This option only
> -useful for KEXEC_LOAD syscall.
> +Setup kexec segments such that kernel can safely update them on CPU/Memory
> +hot add/remove events. If this option is enabled, kernel does in-kernel

> +update of kexec segments on CPU/Memory hot add/remove events. Helps avoid
> +the need to reload kdump kernel.

s/events. Helps avoid the need/events, thus avoiding the need/

>   .TP
>   .B \-i\ (\-\-no-checks)
>   Fast reboot, no memory integrity checks.
> diff --git a/kexec/kexec.c b/kexec/kexec.c
> index 034cea6..db8e2b3 100644
> --- a/kexec/kexec.c
> +++ b/kexec/kexec.c
> @@ -1093,7 +1093,9 @@ void usage(void)
>   	       "                      back to the compatibility syscall when file based\n"
>   	       "                      syscall is not supported or the kernel did not\n"
>   	       "                      understand the image (default)\n"
> -	       " --hotplug            Setup for kernel modification of elfcorehdr.\n"
> +	       " --hotplug            Do in-kernel update of kexec segments on CPU/Memory\n"

> +	       "                      hot add/remove events. This avoids the need to reload\n"

s/events. This avoids/events, avoiding/

> +	       "                      kdump kernel or on/offline events.\n"

s/kernel or on/kernel on online/

>   	       " -d, --debug          Enable debugging to help spot a failure.\n"
>   	       " -S, --status         Return 1 if the type (by default crash) is loaded,\n"
>   	       "                      0 if not.\n"