Re: [Qemu-devel] [PATCH 2/3] qemu-options.hx: refer to confdir instead of sysconfdir on docs

[Eduardo Habkost]

On Wed, Mar 21, 2012 at 01:43:58PM +0100, Paolo Bonzini wrote:
> Il 20/03/2012 21:15, Eduardo Habkost ha scritto:
> > The current docs are wrong: ${sysconfdir} is (by default) /etc,
> > ${confdir} is (by default) /etc/qemu, that's where the config files are
> > stored.
> > 
> > Signed-off-by: Eduardo Habkost <address@hidden>
> > ---
> >  qemu-options.hx |    4 ++--
> >  1 files changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/qemu-options.hx b/qemu-options.hx
> > index daefce3..39578f1 100644
> > --- a/qemu-options.hx
> > +++ b/qemu-options.hx
> > @@ -2676,8 +2676,8 @@ DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
> >  STEXI
> >  @item -nodefconfig
> >  @findex -nodefconfig
> > -Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf 
> > and
> > address@hidden/address@hidden on startup.  The @code{-nodefconfig}
> > +Normally QEMU loads a configuration file from @var{confdir}/qemu.conf and
> > address@hidden/address@hidden on startup.  The @code{-nodefconfig}
> >  option will prevent QEMU from loading these configuration files at startup.
> >  ETEXI
> >  DEF("trace", HAS_ARG, QEMU_OPTION_trace,
> 
> There's no definition of confdir and sysconfdir in the documentation.
> Perhaps writing @var{sysconfdir}/qemu/qemu.conf is better for now?

Maybe it would be better, yes, as it gives a better hint for the user of
where the config directory may be.

But it's still not very clear for the user. Is it possible to expand
build-time config variables inside the documentation so they show the
full path? I have zero knowledge about texinfo, and even less about the
texinfo conversion scripts Qemu uses (do they support the full texinfo
language, or just a subset of it?).

-- 
Eduardo