Re: [PATCH v3 2/2] Document qemu-ifup on NetBSD

[Roger Pau Monné <roger.pau@xxxxxxxxxx>]

On Mon, Feb 01, 2021 at 10:37:47AM +0100, Manuel Bouyer wrote:
> On Mon, Feb 01, 2021 at 09:21:58AM +0100, Roger Pau Monné wrote:
> > On Sun, Jan 31, 2021 at 12:03:00AM +0100, Manuel Bouyer wrote:
> > > Document that on NetBSD, the tap interface will be configured by the
> > > qemu-ifup script. Document the arguments, and XEN_DOMAIN_ID environnement
> > > variable.
> > 
> > You are missing a Signed-off-by tag here ;).
> > 
> > > ---
> > >  docs/man/xl-network-configuration.5.pod | 4 ++++
> > >  1 file changed, 4 insertions(+)
> > > 
> > > diff --git a/docs/man/xl-network-configuration.5.pod 
> > > b/docs/man/xl-network-configuration.5.pod
> > > index af058d4d3c..f6eb6c31fc 100644
> > > --- a/docs/man/xl-network-configuration.5.pod
> > > +++ b/docs/man/xl-network-configuration.5.pod
> > > @@ -172,6 +172,10 @@ add it to the relevant bridge). Defaults to
> > >  C<XEN_SCRIPT_DIR/vif-bridge> but can be set to any script. Some example
> > >  scripts are installed in C<XEN_SCRIPT_DIR>.
> > >  
> > > +On NetBSD, HVM guests will always use
> > > +C<XEN_SCRIPT_DIR/qemu-ifup> to configure the tap interface. The first 
> > > argument
> > > +is the tap interface, the second is the bridge name. the environnement 
> > > variable
> > > +C<XEN_DOMAIN_ID> contains the domU's ID.
> > 
> > LGTM, but I would make it even less technical and more user focused:
> > 
> > Note on NetBSD HVM guests will ignore the script option for tap
> > (emulated) interfaces and always use C<XEN_SCRIPT_DIR/qemu-ifup> to
> > configure the interface in bridged mode.
> 
> Well, as a user, I want to know how the scripts are called, so that I can
> tune them ...

Isn't that information on the header of the script? I would expect
users that want to modify such script will open it and then the header
should already lists the parameters.

IMO I would leave the parameters out of this document because we don't
list them for any other script, so it seems odd to list them for the
qemu-ifup script only.

Thanks, Roger.