[PATCH 0/6] wic/help: Refresh wic create help and usage strings

[PATCH 0/6] wic/help: Refresh wic create help and usage strings

[Gaël PORTAY]

Hello maintainers,

That patch series refreshes a bit the help and usage strings for wic
create.

The first patch removes the removed option --infile, while the following
two patches list the missing options --no-fstab-update and --workdir as
compared to `wic create` output:

	usage: wic create [-h] [-o OUTDIR] [-w WORKDIR] [-e IMAGE_NAME]
	                  [-r ROOTFS_DIR] [-b BOOTIMG_DIR]
	                  [-k KERNEL_DIR] [-n NATIVE_SYSROOT] [-s] [-f]
	                  [-c {gzip,bzip2,xz}] [-m] [--no-fstab-update]
	                  [-v VARS_DIR] [-D] [-i IMAGER]
	                  [--extra-space EXTRA_SPACE]
	                  [--sector-size SECTOR_SIZE]
	                  wks_file
	wic create: error: the following arguments are required: wks_file

The fourth patch fixes inconsistent output between options by replacing
the character `|' to `,'.

The fifth patch updates the output of command `wic create` that is
hardcoded in the overview help string.

And the last patch outputs option capitalized values that are missing
for options requiring a value; also, it ensure the lines are wrapped to
80-characters.

Regards,
Gaël PORTAY (6):
  wic/help: Drop removed --infile option from help string
  wic/help: List missing option --no-fstab-update to usage string
  wic/help: List missing option --workdir usage string
  wic/help: Use comma to list short and long options
  wic/help: Refresh output of create command in overview help string
  wic/help: Add missing option values and rewrap lines

 src/wic/help.py | 52 +++++++++++++++++++++----------------------------
 1 file changed, 22 insertions(+), 30 deletions(-)

-- 
2.43.0

[PATCH 1/6] wic/help: Drop removed --infile option from help string

[Gaël PORTAY]

The option --infile has been removed since commit 28129187482 (wic:
removed unused command line option).

A reference to removed option were dropped from usage string by commit
c967cb25c68 (wic: Add missing text to usage and help strings); but a
reference in help string has survived up to now.

This kills the very last reference to --infile removed option.

Signed-off-by: Gaël PORTAY <gael.portay+rtone@gmail.com>
---
 src/wic/help.py | 1 -
 1 file changed, 1 deletion(-)

diff --git a/src/wic/help.py b/src/wic/help.py
index 7bc9d70..1d0284f 100644
--- a/src/wic/help.py
+++ b/src/wic/help.py
@@ -708,7 +708,6 @@ DESCRIPTION
        Create a new OpenEmbedded image
 
        usage: wic create <wks file or image name> [-o <DIRNAME> | ...]
-            [-i <JSON PROPERTY FILE> | --infile <JSON PROPERTY_FILE>]
             [-e | --image-name] [-s, --skip-build-check] [-D, --debug]
             [-r, --rootfs-dir] [-b, --bootimg-dir] [-k, --kernel-dir]
             [-n, --native-sysroot] [-f, --build-rootfs]
-- 
2.43.0

[PATCH 2/6] wic/help: List missing option --no-fstab-update to usage string

[Gaël PORTAY]

This lists missing option --no-fstab-update to usage string for 'wic
create'.

As reported by CLI:

	$ wic create
	usage: wic create [-h] [-o OUTDIR] [-w WORKDIR] [-e IMAGE_NAME] [-r ROOTFS_DIR] [-b BOOTIMG_DIR] [-k KERNEL_DIR] [-n NATIVE_SYSROOT] [-s] [-f] [-c {gzip,bzip2,xz}] [-m] [--no-fstab-update] [-v VARS_DIR] [-D] [-i IMAGER] [--extra-space EXTRA_SPACE] [--sector-size SECTOR_SIZE]
	                  wks_file
	wic create: error: the following arguments are required: wks_file

Signed-off-by: Gaël PORTAY <gael.portay+rtone@gmail.com>
---
 src/wic/help.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/wic/help.py b/src/wic/help.py
index 1d0284f..ee5697f 100644
--- a/src/wic/help.py
+++ b/src/wic/help.py
@@ -119,7 +119,7 @@ wic_create_usage = """
             [-e | --image-name] [-s, --skip-build-check] [-D, --debug]
             [-r, --rootfs-dir] [-b, --bootimg-dir]
             [-k, --kernel-dir] [-n, --native-sysroot] [--sector-size <bytes>] [-f, --build-rootfs]
-            [-c, --compress-with] [-m, --bmap]
+            [-c, --compress-with] [-m, --bmap] [--no-fstab-update]
 
  This command creates an OpenEmbedded image based on the 'OE kickstart
  commands' found in the <wks file>.
-- 
2.43.0

[PATCH 3/6] wic/help: List missing option --workdir usage string

[Gaël PORTAY]

This lists missing option --workdir to usage string for 'wic create'.

As reported by CLI:

	$ wic create
	usage: wic create [-h] [-o OUTDIR] [-w WORKDIR] [-e IMAGE_NAME] [-r ROOTFS_DIR] [-b BOOTIMG_DIR] [-k KERNEL_DIR] [-n NATIVE_SYSROOT] [-s] [-f] [-c {gzip,bzip2,xz}] [-m] [--no-fsta
	                  wks_file
	wic create: error: the following arguments are required: wks_file

Signed-off-by: Gaël PORTAY <gael.portay+rtone@gmail.com>
---
 src/wic/help.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/wic/help.py b/src/wic/help.py
index ee5697f..b213e32 100644
--- a/src/wic/help.py
+++ b/src/wic/help.py
@@ -120,6 +120,7 @@ wic_create_usage = """
             [-r, --rootfs-dir] [-b, --bootimg-dir]
             [-k, --kernel-dir] [-n, --native-sysroot] [--sector-size <bytes>] [-f, --build-rootfs]
             [-c, --compress-with] [-m, --bmap] [--no-fstab-update]
+            [-w, --workdir]
 
  This command creates an OpenEmbedded image based on the 'OE kickstart
  commands' found in the <wks file>.
@@ -141,6 +142,7 @@ SYNOPSIS
         [-r, --rootfs-dir] [-b, --bootimg-dir]
         [-k, --kernel-dir] [-n, --native-sysroot] [--sector-size <bytes>] [-f, --build-rootfs]
         [-c, --compress-with] [-m, --bmap] [--no-fstab-update]
+        [-w, --workdir]
 
 DESCRIPTION
     This command creates an OpenEmbedded image based on the 'OE
-- 
2.43.0

[PATCH 4/6] wic/help: Use comma to list short and long options

[Gaël PORTAY]

Usage and help strings lists short option + comma + long option for
every options at the exception of --outdir and --image-name.

This replaces the vertical bar by comma for consistency.

Signed-off-by: Gaël PORTAY <gael.portay+rtone@gmail.com>
---
 src/wic/help.py | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/wic/help.py b/src/wic/help.py
index b213e32..cbdf529 100644
--- a/src/wic/help.py
+++ b/src/wic/help.py
@@ -115,8 +115,8 @@ wic_create_usage = """
 
  Create a new OpenEmbedded image
 
- usage: wic create <wks file or image name> [-o <DIRNAME> | --outdir <DIRNAME>]
-            [-e | --image-name] [-s, --skip-build-check] [-D, --debug]
+ usage: wic create <wks file or image name> [-o, --outdir <DIRNAME>]
+            [-e, --image-name] [-s, --skip-build-check] [-D, --debug]
             [-r, --rootfs-dir] [-b, --bootimg-dir]
             [-k, --kernel-dir] [-n, --native-sysroot] [--sector-size <bytes>] [-f, --build-rootfs]
             [-c, --compress-with] [-m, --bmap] [--no-fstab-update]
@@ -137,8 +137,8 @@ NAME
     wic create - Create a new OpenEmbedded image
 
 SYNOPSIS
-    wic create <wks file or image name> [-o <DIRNAME> | --outdir <DIRNAME>]
-        [-e | --image-name] [-s, --skip-build-check] [-D, --debug]
+    wic create <wks file or image name> [-o, --outdir <DIRNAME>]
+        [-e, --image-name] [-s, --skip-build-check] [-D, --debug]
         [-r, --rootfs-dir] [-b, --bootimg-dir]
         [-k, --kernel-dir] [-n, --native-sysroot] [--sector-size <bytes>] [-f, --build-rootfs]
         [-c, --compress-with] [-m, --bmap] [--no-fstab-update]
-- 
2.43.0

[PATCH 5/6] wic/help: Refresh output of create command in overview help string

[Gaël PORTAY]

The output of wic create with no argument has changed.

This refreshes the ouput of wic create command in the overview help
string.

Signed-off-by: Gaël PORTAY <gael.portay+rtone@gmail.com>
---
 src/wic/help.py | 29 +++++++++--------------------
 1 file changed, 9 insertions(+), 20 deletions(-)

diff --git a/src/wic/help.py b/src/wic/help.py
index cbdf529..05e838a 100644
--- a/src/wic/help.py
+++ b/src/wic/help.py
@@ -705,26 +705,15 @@ DESCRIPTION
 
       $ wic create
 
-       Usage:
-
-       Create a new OpenEmbedded image
-
-       usage: wic create <wks file or image name> [-o <DIRNAME> | ...]
-            [-e | --image-name] [-s, --skip-build-check] [-D, --debug]
-            [-r, --rootfs-dir] [-b, --bootimg-dir] [-k, --kernel-dir]
-            [-n, --native-sysroot] [-f, --build-rootfs]
-
-       This command creates an OpenEmbedded image based on the 'OE
-       kickstart commands' found in the <wks file>.
-
-       The -o option can be used to place the image in a directory
-       with a different name and location.
-
-       See 'wic help create' for more detailed instructions.
-       ...
-
-    As mentioned in the command, you can get even more detailed
-    information by adding 'help' to the above:
+      usage: wic create [-h] [-o OUTDIR] [-w WORKDIR] [-e IMAGE_NAME]
+                        [-r ROOTFS_DIR] [-b BOOTIMG_DIR] [-k KERNEL_DIR]
+                        [-n NATIVE_SYSROOT] [-s] [-f] [-c {gzip,bzip2,xz}]
+                        [-m] [--no-fstab-update] [-v VARS_DIR] [-D] [-i IMAGER]
+                        [--extra-space EXTRA_SPACE] [--sector-size SECTOR_SIZE]
+                        wks_file
+      wic create: error: the following arguments are required: wks_file
+
+    You can get even more detailed information by adding 'help' to the above:
 
       $ wic help create
 
-- 
2.43.0

[PATCH 6/6] wic/help: Add missing option values and rewrap lines

[Gaël PORTAY]

Some options take values, but those values are missing from the usage
and help strings.

	$ wic create
	usage: wic create [-h] [-o OUTDIR] [-w WORKDIR] [-e IMAGE_NAME] [-r ROOTFS_DIR] [-b BOOTIMG_DIR] [-k KERNEL_DIR] [-n NATIVE_SYSROOT] [-s] [-f] [-c {gzip,bzip2,xz}] [-m] [--no-fstab-update]
	                  [-v VARS_DIR] [-D] [-i IMAGER] [--extra-space EXTRA_SPACE] [--sector-size SECTOR_SIZE]
	                  wks_file

This adds and capitalizes the missing option values, and rewraps lines
to 80-characters.

Signed-off-by: Gaël PORTAY <gael.portay+rtone@gmail.com>
---
 src/wic/help.py | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git a/src/wic/help.py b/src/wic/help.py
index 05e838a..837695b 100644
--- a/src/wic/help.py
+++ b/src/wic/help.py
@@ -116,11 +116,12 @@ wic_create_usage = """
  Create a new OpenEmbedded image
 
  usage: wic create <wks file or image name> [-o, --outdir <DIRNAME>]
-            [-e, --image-name] [-s, --skip-build-check] [-D, --debug]
-            [-r, --rootfs-dir] [-b, --bootimg-dir]
-            [-k, --kernel-dir] [-n, --native-sysroot] [--sector-size <bytes>] [-f, --build-rootfs]
-            [-c, --compress-with] [-m, --bmap] [--no-fstab-update]
-            [-w, --workdir]
+            [-e, --image-name <IMGNAME>] [-s, --skip-build-check] [-D, --debug]
+            [-r, --rootfs-dir <DIRNAME>] [-b, --bootimg-dir <DIRNAME>]
+            [-k, --kernel-dir <DIRNAME>] [-n, --native-sysroot <DIRNAME>]
+            [--sector-size <BYTES>] [-f, --build-rootfs]
+            [-c, --compress-with gzip|bzip2|xz] [-m, --bmap]
+            [-w, --workdir <DIRNAME>]
 
  This command creates an OpenEmbedded image based on the 'OE kickstart
  commands' found in the <wks file>.
@@ -138,11 +139,12 @@ NAME
 
 SYNOPSIS
     wic create <wks file or image name> [-o, --outdir <DIRNAME>]
-        [-e, --image-name] [-s, --skip-build-check] [-D, --debug]
-        [-r, --rootfs-dir] [-b, --bootimg-dir]
-        [-k, --kernel-dir] [-n, --native-sysroot] [--sector-size <bytes>] [-f, --build-rootfs]
-        [-c, --compress-with] [-m, --bmap] [--no-fstab-update]
-        [-w, --workdir]
+        [-e, --image-name <IMGNAME>] [-s, --skip-build-check] [-D, --debug]
+        [-r, --rootfs-dir <DIRNAME>] [-b, --bootimg-dir <DIRNAME>]
+        [-k, --kernel-dir <DIRNAME>] [-n, --native-sysroot <DIRNAME>]
+        [--sector-size <BYTES>] [-f, --build-rootfs]
+        [-c, --compress-with gzip|bzip2|xz] [-m, --bmap] [--no-fstab-update]
+        [-w, --workdir <DIRNAME>]
 
 DESCRIPTION
     This command creates an OpenEmbedded image based on the 'OE
-- 
2.43.0

Re: [PATCH 0/6] wic/help: Refresh wic create help and usage strings

[Trevor Woerner]

Oops! I missed these.
Please put the tag [wic] in the email subject in the future, thanks!

On Thu 2026-07-02 @ 06:44:18 AM, Gaël PORTAY wrote:
> Hello maintainers,
> 
> That patch series refreshes a bit the help and usage strings for wic
> create.
> 
> The first patch removes the removed option --infile, while the following
> two patches list the missing options --no-fstab-update and --workdir as
> compared to `wic create` output:
> 
> 	usage: wic create [-h] [-o OUTDIR] [-w WORKDIR] [-e IMAGE_NAME]
> 	                  [-r ROOTFS_DIR] [-b BOOTIMG_DIR]
> 	                  [-k KERNEL_DIR] [-n NATIVE_SYSROOT] [-s] [-f]
> 	                  [-c {gzip,bzip2,xz}] [-m] [--no-fstab-update]
> 	                  [-v VARS_DIR] [-D] [-i IMAGER]
> 	                  [--extra-space EXTRA_SPACE]
> 	                  [--sector-size SECTOR_SIZE]
> 	                  wks_file
> 	wic create: error: the following arguments are required: wks_file
> 
> The fourth patch fixes inconsistent output between options by replacing
> the character `|' to `,'.
> 
> The fifth patch updates the output of command `wic create` that is
> hardcoded in the overview help string.
> 
> And the last patch outputs option capitalized values that are missing
> for options requiring a value; also, it ensure the lines are wrapped to
> 80-characters.
> 
> Regards,
> Gaël PORTAY (6):
>   wic/help: Drop removed --infile option from help string
>   wic/help: List missing option --no-fstab-update to usage string
>   wic/help: List missing option --workdir usage string
>   wic/help: Use comma to list short and long options
>   wic/help: Refresh output of create command in overview help string
>   wic/help: Add missing option values and rewrap lines
> 
>  src/wic/help.py | 52 +++++++++++++++++++++----------------------------
>  1 file changed, 22 insertions(+), 30 deletions(-)
> 
> -- 
> 2.43.0
> 

Re: [PATCH 0/6] wic/help: Refresh wic create help and usage strings

[Gaël PORTAY]

On Thu Jul 9, 2026 at 5:51 AM CEST, Trevor Woerner wrote:
> Oops! I missed these.
> Please put the tag [wic] in the email subject in the future, thanks!
>

Oops! I forgot to set the tag for that series.

At least, I have set the tag for the other patch; I will do my best to
add it in the future :)

Regards,
Gaël