[pve-devel] [PATCH zsync 03/10] usage: describe flag parameters correctly

Fabian Ebner f.ebner at proxmox.com
Tue May 4 10:09:57 CEST 2021


It's not possible to provide a false value. From the documentation for
GetOptionsFromArray:
    The argument specification is optional. If omitted, the option is considered
    boolean, a value of 1 will be assigned when the option is used on the
    command line.

Make it clear that specifying the flag alone already enables it.

Signed-off-by: Fabian Ebner <f.ebner at proxmox.com>
---
 pve-zsync | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/pve-zsync b/pve-zsync
index deecfed..2c10a4d 100755
--- a/pve-zsync
+++ b/pve-zsync
@@ -1114,9 +1114,9 @@ $PROGNAME create -dest <string> -source <string> [OPTIONS]
 
 		name of the sync job, if not set it is default
 
-        -skip      boolean
+        -skip
 
-		if this flag is set it will skip the first sync
+		If specified, skip the first sync.
 
         -source    string
 
@@ -1126,9 +1126,9 @@ $PROGNAME create -dest <string> -source <string> [OPTIONS]
 
 		name of the user on the source target, root by default
 
-	-properties	boolean
+	-properties
 
-		Include the dataset's properties in the stream.
+		If specified, include the dataset's properties in the stream.
 
 	-dest-config-path    string
 
@@ -1168,13 +1168,13 @@ $PROGNAME sync -dest <string> -source <string> [OPTIONS]\n
 
 		name of the user on the source target, root by default
 
-	-verbose   boolean
+	-verbose
 
-		print out the sync progress.
+		If specified, print out the sync progress.
 
-	-properties	boolean
+	-properties
 
-		Include the dataset's properties in the stream.
+		If specified, include the dataset's properties in the stream.
 
 	-dest-config-path    string
 
@@ -1199,7 +1199,7 @@ $PROGNAME help <cmd> [OPTIONS]
 
 		Command name
 
-	-verbose   boolean
+	-verbose
 
 		Verbose output format.
     },
-- 
2.20.1





More information about the pve-devel mailing list