qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Eric Blake <eblake@redhat.com>
To: "Qemu-devel@nongnu.org" <Qemu-devel@nongnu.org>,
	Paolo Bonzini <pbonzini@redhat.com>,
	Kevin Wolf <kwolf@redhat.com>, Max Reitz <mreitz@redhat.com>,
	Michael Roth <mdroth@linux.vnet.ibm.com>,
	qemu block <qemu-block@nongnu.org>
Subject: [Qemu-devel] RFC: unified --help information
Date: Wed, 26 Jul 2017 05:53:52 -0500	[thread overview]
Message-ID: <f3b1276a-92e3-54f3-c6a0-5f8e16124014@redhat.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 1410 bytes --]

I noticed that some utilities provide a handy link to the website (which
in turn connects the users to bug database, mailing list, online docs,
...); for example, look at 'ls --help | tail -n3':

GNU coreutils online help: <http://www.gnu.org/software/coreutils/>
Full documentation at: <http://www.gnu.org/software/coreutils/ls>
or available locally via: info '(coreutils) ls invocation'

or 'm4 --help | tail -n3':
Report bugs to: bug-m4@gnu.org
GNU M4 home page: <http://www.gnu.org/software/m4/>
General help using GNU software: <http://www.gnu.org/gethelp/>

In our executables, we are rather inconsistent with --help

qemu-nbd mentions: Report bugs to <qemu-devel@nongnu.org>
qemu-ga mentions: Report bugs to <mdroth@linux.vnet.ibm.com>

while qemu-system-*, qemu-img, and qemu-io mention nothing at all.  Is
it worth unifying these to all mention qemu-devel@nongnu.org as the
primary bug-report site, and/or to add mention of <http://qemu.org> as a
site for further information?

Likewise, with --version, qemu-io and qemu-ga lack the git suffix
present in qemu-system-* and just added in qemu-nbd.

I can submit patches to make things consistent, and think it is 2.10
material, but first want to get consensus on what the behavior should be.

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 619 bytes --]

             reply	other threads:[~2017-07-26 10:54 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-26 10:53 Eric Blake [this message]
2017-07-26 11:11 ` [Qemu-devel] RFC: unified --help information Paolo Bonzini
2017-07-26 11:22   ` Eric Blake
2017-07-26 11:35     ` Peter Maydell

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=f3b1276a-92e3-54f3-c6a0-5f8e16124014@redhat.com \
    --to=eblake@redhat.com \
    --cc=Qemu-devel@nongnu.org \
    --cc=kwolf@redhat.com \
    --cc=mdroth@linux.vnet.ibm.com \
    --cc=mreitz@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=qemu-block@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).