Re: [Qemu-devel] [PATCH] Add -netdev to man page

[Markus Armbruster]

Miroslav Rezanina <address@hidden> writes:

> Hi Markus,
> thanks for comments see inline:
>
> ----- Original Message -----
>> From: "Markus Armbruster" <address@hidden>
>> To: "Miroslav Rezanina" <address@hidden>
>> Cc: address@hidden
>> Sent: Thursday, March 1, 2012 4:50:35 PM
>> Subject: Re: [Qemu-devel] [PATCH] Add -netdev to man page
>> 
>> Miroslav Rezanina <address@hidden> writes:
>> 
>> > There's missing -netdev description in the man page for qemu. As
>> > this is
>> > recommended way to create network backend, lack of documentation
>> > can discourage
>> > its usage.
>> 
>> Very much appreciated!
>> 
>> > -net option is preserved but marked as obsolete way.
>> >
>> > Signed-off-by: Miroslav Rezanina <address@hidden>
>> >
>> > Patch:
>> > -----
>> > diff --git a/qemu-options.hx b/qemu-options.hx
>> > index b129996..a1d61b6 100644
>> > --- a/qemu-options.hx
>> > +++ b/qemu-options.hx
>> > @@ -1292,6 +1292,268 @@ DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
>> >  #endif
>> >      "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
>> >  STEXI
>> > address@hidden -netdev
>> > user|tap|vde|socket,address@hidden,option][,option][,...]
>> > +
>> > +Create a new network backend to the guest. The backend's
>> > @option{id} can be used with
>> 
>> Suggest to drop "to the guest".
>> 
>> > +the @option{-device} option to connect a backend with a device,
>> > +e.g.
>> > +
>> > address@hidden
>> > +-netdev user,id=mynet -device e1000,netdev=mynet
>> > address@hidden example
>> > +
>> > +You can use following types of backend:
>> > +
>> > address@hidden @option
>> > +
>> > address@hidden -netdev user
>> > +
>> > +User networking is default network backend. This backend does not
>> > require root
>> > +priviledges, does not allow ICMP trafic and host is not directly
>> > accessible
>> > +from the host or the external network.
>> 
>> privileges
>> 
>> traffic
>> 
>> Suggest you use a spell checker :)
>> 
>> Comma after "traffic", please.
>> 
>> Err, "host is not directly accessible from the host"...  Do you mean
>> "guest is not"?
>
> Yeah, I have to find one...As I rewrite code too often, I'm blind to this.

M-x ispell-region :)

>> > +Valid options are:
>> > +
>> > address@hidden @option
>> > +
>> > address@hidden restrict=y|yes|n|no
>> 
>> For -net, this is documented as restrict=on|off.  All these values
>> are
>> actually recognized.  I find that somewhat baroque, and don't
>> particularly care which ones you document :)
>> 
>> > +If this options is enabled, the guest will be isolated, i.e. it
>> > will not be
>> 
>> option
>
> What documentation do you mean?? It's look like there's more differences
> to check.

I compared against @item -net user in the same file.

[...]