qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Peter Maydell <peter.maydell@linaro.org>
To: QEMU Developers <qemu-devel@nongnu.org>
Cc: Paolo Bonzini <pbonzini@redhat.com>,
	Eduardo Habkost <ehabkost@redhat.com>
Subject: [Qemu-devel] what is the syntax and meaning of -numa cpus=foo-bar ?
Date: Mon, 23 Jan 2017 15:14:28 +0000	[thread overview]
Message-ID: <CAFEAcA8bVVwdLAuF-wV4_mYCL0XvN6-jdnmnPgQR765xaAc1hg@mail.gmail.com> (raw)

Hi; something we noticed recently is that some versions of
makeinfo gripe about the -numa option syntax in qemu-options.hx:

qemu-options.texi:60: warning: unlikely character [ in @var.
qemu-options.texi:60: warning: unlikely character ] in @var.
qemu-options.texi:61: warning: unlikely character [ in @var.
qemu-options.texi:61: warning: unlikely character ] in @var.

This is provoked by qemu-options.hx having:

@item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
@itemx -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]

The obvious simple syntax fix is to change it to
"cpus=@var{cpu}[-@var{cpu}]" (ie the @var{} covers only
the metasyntactic variables the user has to fill in,
not the '-' which is I think a literal and the [] which
are indicating that the second part is optional).

However, this leaves me still rather in the dark as a user of
the documentation about what the option actually does. The
text below doesn't explain what the two 'cpu' fields I
can fill in do, or what values they can take. They should
probably be different names as well (eg "start-end", or
whatever makes sense for the semantics) so that the text
can refer to them usefully.

Would somebody who understands the -numa option like to
propose a few lines of text to clarify things?

thanks
-- PMM

             reply	other threads:[~2017-01-23 15:14 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-01-23 15:14 Peter Maydell [this message]
2017-01-23 16:23 ` [Qemu-devel] what is the syntax and meaning of -numa cpus=foo-bar ? Eduardo Habkost

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=CAFEAcA8bVVwdLAuF-wV4_mYCL0XvN6-jdnmnPgQR765xaAc1hg@mail.gmail.com \
    --to=peter.maydell@linaro.org \
    --cc=ehabkost@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=qemu-devel@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).