Re: [Qemu-devel] [PATCH v5 4/9] qemu-binfmt-conf.sh: use the same presentation format as for qemu-*

[Laurent Vivier]

On 11/03/2019 21:20, Unai Martinez-Corral wrote:
> Signed-off-by: Unai Martinez-Corral <address@hidden>
> ---
>  scripts/qemu-binfmt-conf.sh | 63 +++++++++++++++++++------------------
>  1 file changed, 32 insertions(+), 31 deletions(-)
> 
> diff --git a/scripts/qemu-binfmt-conf.sh b/scripts/qemu-binfmt-conf.sh
> index ad9ae731a0..35f61d9a6c 100755
> --- a/scripts/qemu-binfmt-conf.sh
> +++ b/scripts/qemu-binfmt-conf.sh
> @@ -167,47 +167,48 @@ 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
> +-p|--persistent      QEMU_PERSISTENT  (yes) load the interpreter and keep it 
> in memory; all future
> +                                      uses are cloned from the open file.
> +-c|--credential      QEMU_CREDENTIAL  (yes) credential and security tokens 
> are calculated according
> +                                      to the binary to interpret
> +-e|--exportdir PATH  DEBIANDIR        define where to write configuration 
> files
> +                     SYSTEMDDIR

DEBIANDIR and SYSTEMDDIR are not env-variable, so they shouldn't be in
the list. But you must display their values to allow the user to know
where files are put.

Thanks,
Laurent
> +-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.
> +-d|--debian                           don't write into /proc, generate 
> update-binfmts templates
> 
> -        sudo update-binfmts --importdir ${EXPORTDIR:-$DEBIANDIR} --import 
> qemu-CPU
> +Defaults:
> +QEMU_PATH=$QEMU_PATH
> +QEMU_PERSISTENT=$QEMU_PERSISTENT
> +QEMU_CREDENTIAL=$QEMU_CREDENTIAL
> 
> -    To remove interpreter, use :
> +To import templates with update-binfmts, use :
> 
> -        sudo update-binfmts --package qemu-CPU --remove qemu-CPU $QEMU_PATH
> +    sudo update-binfmts --importdir ${EXPORTDIR:-$DEBIANDIR} --import 
> qemu-CPU
> 
> -    With systemd, binfmt files are loaded by systemd-binfmt.service
> +To remove interpreter, use :
> 
> -    The environment variable HOST_ARCH allows to override 'uname' to generate
> -    configuration files for a different architecture than the current one.
> +    sudo update-binfmts --package qemu-CPU --remove qemu-CPU $QEMU_PATH
> 
> -    where CPU is one of:
> +With systemd, binfmt files are loaded by systemd-binfmt.service
> 
> -        $qemu_target_list
> +The environment variable HOST_ARCH allows to override 'uname' to generate 
> configuration files for a
> +different architecture than the current one.
> +
> +where CPU is one of:
> +
> +    $qemu_target_list
> 
>  EOF
>  }
> --
> 2.21.0
>