Re: [Qemu-devel] [PATCH v2.1 3/4] doc: add item for "-M enforce-config-section"

[Peter Xu]

On Thu, Jul 06, 2017 at 10:09:19AM +0200, Greg Kurz wrote:
> On Thu,  6 Jul 2017 10:08:41 +0800
> Peter Xu <address@hidden> wrote:
> 
> > It's never documented, and now we have one more parameter for it (which
> > obsoletes this one). Document it properly.
> > 
> > Although now when enforce-config-section is set, it'll override the
> > other "-global" parameter, that is not necessarily a rule. Forbid that
> > usage in the document.
> > 
> > Suggested-by: Eduardo Habkost <address@hidden>
> > Signed-off-by: Peter Xu <address@hidden>
> > ---
> > v2.1:
> > - remove the "undefined behavior" sentence [Markus]
> > 
> >  qemu-options.hx | 8 ++++++++
> >  1 file changed, 8 insertions(+)
> > 
> > diff --git a/qemu-options.hx b/qemu-options.hx
> > index 297bd8a..1ce7a37 100644
> > --- a/qemu-options.hx
> > +++ b/qemu-options.hx
> > @@ -85,6 +85,14 @@ Enables or disables NVDIMM support. The default is off.
> >  @item s390-squash-mcss=on|off
> >  Enables or disables squashing subchannels into the default css.
> >  The default is off.
> > address@hidden enforce-config-section=on|off
> > +If @option{enforce-config-section} is set to @var{on}, force migration
> > +code to send configuration section even if the machine-type sets the
> > address@hidden property to @var{off}.
> > +NOTE: this parameter is deprecated. Please use @option{-global}
> > address@hidden@var{on|off} instead.
> > address@hidden cannot be used together with
> > address@hidden @option{migration.send-configuration}.
> 
> Is this last sentence correct ?
> 
> My understanding is that "enforce-config-section" overrides
> "migration.send-configuration"...

Yes, in the codes it is.

But as mentioned in the commit message, this rule is actually not
really necessary, so it does not really conflict when we declare in
the document that it is not allowed to happen (the code just did
something extra). After all, we want to finally remove
enforce-config-section one day, so before that I would like to avoid
taking more responsibility on this old parameter.

Also, I hope people (especially who read this document) don't use
these two parameters at the same time, or better, use the new one,
rather than still using "enforce-config-section" after he knows that
"anyway, it'll override the global parameter, so this old one is still
better"...

Thanks,

-- 
Peter Xu