Commit f5048cb7 authored by Eric Blake's avatar Eric Blake Committed by Paolo Bonzini
Browse files

maint: Include bug-reporting info in --help output 



These days, many programs are including a bug-reporting address,
or better yet, a link to the project web site, at the tail of
their --help output.  However, we were not very consistent at
doing so: only qemu-nbd and qemu-qa mentioned anything, with the
latter pointing to an individual person instead of the project.

Add a new #define that sets up a uniform string, mentioning both
bug reporting instructions and overall project details, and which
a downstream vendor could tweak if they want bugs to go to a
downstream database.  Then use it in all of our binaries which
have --help output.

The canned text intentionally references http:// instead of https://
because our https website currently causes certificate errors in
some browsers.  That can be tweaked later once we have resolved the
web site issued.

Signed-off-by: default avatarEric Blake <eblake@redhat.com>
Reviewed-by: default avatarDaniel P. Berrange <berrange@redhat.com>
Reviewed-by: default avatarPhilippe Mathieu-Daudé <f4bug@amsat.org>
Message-Id: <20170803163353.19558-5-eblake@redhat.com>
Signed-off-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
parent 8f1c29af

bsd-user/main.c

+2 −0
Original line number Diff line number Diff line
@@ -686,6 +686,8 @@ static void usage(void) 
           "    -E var1=val2 -E var2=val2 -U LD_PRELOAD -U LD_DEBUG\n"

           "Note that if you provide several changes to single variable\n"

           "last change will stay in effect.\n"

           "\n"

           QEMU_HELP_BOTTOM "\n"

           ,

           TARGET_NAME,

           interp_prefix,

include/qemu-common.h

+5 −0
Original line number Diff line number Diff line
@@ -22,6 +22,11 @@ 
#define QEMU_COPYRIGHT "Copyright (c) 2003-2017 " \

    "Fabrice Bellard and the QEMU Project developers"



/* Bug reporting information for --help arguments, About dialogs, etc */

#define QEMU_HELP_BOTTOM \

    "See <http://qemu.org/contribute/report-a-bug> for how to report bugs.\n" \

    "More information on the QEMU project at <http://qemu.org>."



/* main function, renamed */

#if defined(CONFIG_COCOA)

int qemu_main(int argc, char **argv, char **envp);

linux-user/main.c

+3 −1
Original line number Diff line number Diff line
@@ -4136,7 +4136,9 @@ static void usage(int exitcode) 
           "    -E var1=val2,var2=val2 -U LD_PRELOAD,LD_DEBUG\n"

           "    QEMU_SET_ENV=var1=val2,var2=val2 QEMU_UNSET_ENV=LD_PRELOAD,LD_DEBUG\n"

           "Note that if you provide several changes to a single variable\n"

           "the last change will stay in effect.\n");

           "the last change will stay in effect.\n"

           "\n"

           QEMU_HELP_BOTTOM "\n");



    exit(exitcode);

}

qemu-img.c

+1 −1
Original line number Diff line number Diff line
@@ -201,7 +201,7 @@ static void QEMU_NORETURN help(void) 


    printf("%s\nSupported formats:", help_msg);

    bdrv_iterate_format(format_print, NULL);

    printf("\n");

    printf("\n\n" QEMU_HELP_BOTTOM "\n");

    exit(EXIT_SUCCESS);

}

qemu-io.c

+3 −2
Original line number Diff line number Diff line
@@ -262,8 +262,9 @@ static void usage(const char *name) 
"  -h, --help           display this help and exit\n"

"  -V, --version        output version information and exit\n"

"\n"

"See '%s -c help' for information on available commands."

"\n",

"See '%s -c help' for information on available commands.\n"

"\n"

QEMU_HELP_BOTTOM "\n",

    name, name);

}