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

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

[Alexander Zeidler]

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
---
v2:
* incorporate all feedback from v1

v1: https://lists.proxmox.com/pipermail/pve-devel/2024-April/063252.html


 bin/Makefile | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/bin/Makefile b/bin/Makefile
index 180a91b5..6c5f9b14 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 detect common pitfalls and misconfigurations\
+	 before and during the upgrade of a Proxmox VE system.\n" >> $@.tmp
+	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 for your setup, double-check that before proceeding.\n" >> $@.tmp
 	printf ".SH SYNOPSIS\npve7to8 [--full]\n" >> $@.tmp
 	mv $@.tmp $@
 
-- 
2.39.2



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

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

[Fiona Ebner]

Am 19.04.24 um 18:33 schrieb Alexander Zeidler:
> diff --git a/bin/Makefile b/bin/Makefile
> index 180a91b5..6c5f9b14 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 detect common pitfalls and misconfigurations\
> +	 before and during the upgrade of a Proxmox VE system.\n" >> $@.tmp
> +	printf "Any failures or warnings must be addressed prior to the upgrade.\n" >> $@.tmp

Nit: "All failures and warnings" sounds slightly better IMHO

> +	printf "If you think that a message is a false-positive for your setup, double-check that before proceeding.\n" >> $@.tmp

The old wording was a bit stronger:
- with the new wording, failures and warnings are put into the same bucket
- I do like the "carefully evaluated" more than a simple "double-check"

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


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel