[v4,4/10] qemu-binfmt-conf.sh: use the same presentation format as for qemu-*

Commit Message

Unai Martinez Corral March 11, 2019, 10:27 a.m. UTC

Signed-off-by: Unai Martinez-Corral <[e-mail]>
---
 scripts/qemu-binfmt-conf.sh | 58 +++++++++++++++++--------------------
 1 file changed, 27 insertions(+), 31 deletions(-)

--
2.21.0

Comments

Laurent Vivier March 11, 2019, 11:22 a.m. UTC | #1

On 11/03/2019 11:27, Unai Martinez-Corral wrote:
> 
> Signed-off-by: Unai Martinez-Corral <[e-mail]>
> ---
>  scripts/qemu-binfmt-conf.sh | 58 +++++++++++++++++--------------------
>  1 file changed, 27 insertions(+), 31 deletions(-)
> 
> diff --git a/scripts/qemu-binfmt-conf.sh b/scripts/qemu-binfmt-conf.sh
> index e7a714e22c..489d7d2326 100755
> --- a/scripts/qemu-binfmt-conf.sh
> +++ b/scripts/qemu-binfmt-conf.sh
> @@ -167,47 +167,43 @@ qemu_get_family() {
> 
>  usage() {
>      cat <<EOF
> -Usage: qemu-binfmt-conf.sh [--qemu-path PATH][--debian][--systemd CPU]
> -                           [--help][--credential][--exportdir PATH]
> -                           [--persistent][--qemu-suffix SUFFIX]
> +Usage: qemu-binfmt-conf.sh [options]
> 
> -       Configure binfmt_misc to use qemu interpreter
> +Configure binfmt_misc to use qemu interpreter
> 
> -       --help:        display this usage
> -       --qemu-path:   set path to qemu interpreter ($QEMU_PATH)
> -       --qemu-suffix: add a suffix to the default interpreter name
> -       --debian:      don't write into /proc,
> -                      instead generate update-binfmts templates
> -       --systemd:     don't write into /proc,
> -                      instead generate file for systemd-binfmt.service
> -                      for the given CPU. If CPU is "ALL", generate a
> -                      file for all known cpus
> -       --exportdir:   define where to write configuration files
> -                      (default: $SYSTEMDDIR or $DEBIANDIR)
> -       --credential:  if present, credential and security tokens are
> -                      calculated according to the binary to interpret
> -                      ($QEMU_CREDENTIAL=yes)
> -       --persistent:  if present, the interpreter is loaded when binfmt is
> -                      configured and remains in memory. All future uses
> -                      are cloned from the open file.
> -                      ($QEMU_PERSISTENT=yes)
> +Options and associated environment variables:
> 
> -    To import templates with update-binfmts, use :
> +Argument             Env-variable     Description
> +-h|--help                             display this usage
> +-Q|--qemu-path PATH: QEMU_PATH        set path to qemu interpreter

Please, remove all the ':' above and below.
You should merge PATCH 9/10 with this one.

Thanks,
Laurent

Patch

diff --git a/scripts/qemu-binfmt-conf.sh b/scripts/qemu-binfmt-conf.sh
index e7a714e22c..489d7d2326 100755
--- a/scripts/qemu-binfmt-conf.sh
+++ b/scripts/qemu-binfmt-conf.sh
@@ -167,47 +167,43 @@  qemu_get_family() {

 usage() {
     cat <<EOF
-Usage: qemu-binfmt-conf.sh [--qemu-path PATH][--debian][--systemd CPU]
-                           [--help][--credential][--exportdir PATH]
-                           [--persistent][--qemu-suffix SUFFIX]
+Usage: qemu-binfmt-conf.sh [options]

-       Configure binfmt_misc to use qemu interpreter
+Configure binfmt_misc to use qemu interpreter

-       --help:        display this usage
-       --qemu-path:   set path to qemu interpreter ($QEMU_PATH)
-       --qemu-suffix: add a suffix to the default interpreter name
-       --debian:      don't write into /proc,
-                      instead generate update-binfmts templates
-       --systemd:     don't write into /proc,
-                      instead generate file for systemd-binfmt.service
-                      for the given CPU. If CPU is "ALL", generate a
-                      file for all known cpus
-       --exportdir:   define where to write configuration files
-                      (default: $SYSTEMDDIR or $DEBIANDIR)
-       --credential:  if present, credential and security tokens are
-                      calculated according to the binary to interpret
-                      ($QEMU_CREDENTIAL=yes)
-       --persistent:  if present, the interpreter is loaded when binfmt is
-                      configured and remains in memory. All future uses
-                      are cloned from the open file.
-                      ($QEMU_PERSISTENT=yes)
+Options and associated environment variables:

-    To import templates with update-binfmts, use :
+Argument             Env-variable     Description
+-h|--help                             display this usage
+-Q|--qemu-path PATH: QEMU_PATH        set path to qemu interpreter
+-F|--qemu-suffix SUFFIX:              add a suffix to the default interpreter name
+-d|--debian:                          don't write into /proc, generate update-binfmts templates
+-s|--systemd CPU:                     don't write into /proc, generate file for
+                                      systemd-binfmt.service for the given CPU; if CPU is "ALL",
+                                      generate a file for all known cpus.
+-e|--exportdir PATH: DEBIANDIR        define where to write configuration files
+                     SYSTEMDDIR
+-c|--credential:     QEMU_CREDENTIAL  (yes) credential and security tokens are calculated according
+                                      to the binary to interpret
+-p|--persistent:     QEMU_PERSISTENT  (yes) load the interpreter and keep it in memory; all future
+                                      uses are cloned from the open file.

-        sudo update-binfmts --importdir ${EXPORTDIR:-$DEBIANDIR} --import qemu-CPU
+To import templates with update-binfmts, use :

-    To remove interpreter, use :
+    sudo update-binfmts --importdir ${EXPORTDIR:-$DEBIANDIR} --import qemu-CPU

-        sudo update-binfmts --package qemu-CPU --remove qemu-CPU $QEMU_PATH
+To remove interpreter, use :

-    With systemd, binfmt files are loaded by systemd-binfmt.service
+    sudo update-binfmts --package qemu-CPU --remove qemu-CPU $QEMU_PATH

-    The environment variable HOST_ARCH allows to override 'uname' to generate
-    configuration files for a different architecture than the current one.
+With systemd, binfmt files are loaded by systemd-binfmt.service

-    where CPU is one of:
+The environment variable HOST_ARCH allows to override 'uname' to generate configuration files for a
+different architecture than the current one.

-        $qemu_target_list
+where CPU is one of:
+
+    $qemu_target_list

 EOF
 }