[pve-devel] [PATCH manager] pve7to8: reword and fix typos in description

[Stefan Sterz]

On Thu Apr 18, 2024 at 9:44 AM CEST, Alexander Zeidler wrote:
> Signed-off-by: Alexander Zeidler <a.zeidler at proxmox.com>
> ---
>  bin/Makefile | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/bin/Makefile b/bin/Makefile
> index 180a91b5..aa149c06 100644
> --- a/bin/Makefile
> +++ b/bin/Makefile
> @@ -66,10 +66,10 @@ pve6to7.1:
>
>  pve7to8.1:
>  	printf ".TH PVE7TO8 1\n.SH NAME\npve7to8 \- Proxmox VE upgrade checker script for 7.4+ to current 8.x\n" > $@.tmp
> -	printf ".SH DESCRIPTION\nThis tool will help you to detect common pitfalls and misconfguration\
> -	 before, and during the upgrade of a Proxmox VE system\n" >> $@.tmp
> -	printf "Any failure must be addressed before the upgrade, and any waring must be addressed, \
> -	 or at least carefully evaluated, if a false-positive is suspected\n" >> $@.tmp
> +	printf ".SH DESCRIPTION\nThis tool will help you to detect common pitfalls and misconfiguration\

nit: the "to" in "to detect" is superfluous, "will help you detect"
flows much nicer

also, and this is a matter of personal style "misconfigurations" sounds
better to me here because you stay in the plural, but that's really
minor.

> +	 before, and during the upgrade of a Proxmox VE system.\n" >> $@.tmp

i know this is pre-existing, but since you are touching this anyway: the
comma here is odd, if this was supposed to be an oxford comma (or serial
comma), please be aware that these only apply in lists of three or more
items. here we have two lists of two items, so the oxford comma does not
apply.

> +	printf "Any failures or warnings must be addressed prior to the upgrade.\n" >> $@.tmp
> +	printf "If you think that a message is a false-positive, check this carefully before proceeding.\n" >> $@.tmp

again a matter of personal taste, but "check this carefully" sounds a
bit clumsy to me. maybe "double-check that the tool is incorrect before
proceeding".

>  	printf ".SH SYNOPSIS\npve7to8 [--full]\n" >> $@.tmp
>  	mv $@.tmp $@
>