On Wed, 27 Oct 2021 07:28:32 +1000
David Gwynne <da...@gwynne.id.au>:

> On Tue, Oct 26, 2021 at 09:18:30PM +0200, Solene Rapenne wrote:
> > I tried to figure out how to use veb interfaces but the man page
> > wasn't obvious in regards to the "vport" thing. It turns out it's
> > a kind of interface that can be created with ifconfig.
> > 
> > I think we should make this clearer.  
> 
> agreed. the man page for veb/vport is definitely not... rigorous.
> 
> > Because ifconfig(8) mentions many type of interfaces I've searched
> > for "vport" without success while "most" types are referenced in
> > the man page. Like I added veb(4) recently, the diff adds vport(4)
> > and missing mpip(4) so a search would give a clue it's related to
> > ifconfig.  
> 
> I'm ok with the ifconfig chunk.
> 
> > in veb(4), I think we should add vport in the synposis because the
> > man page is shared for veb and vport interfaces but at first look
> > it seems only veb is a type of interface.  
> 
> The synopsis shows what you put into a kernel config file (eg 
> src/sys/conf/GENERIC) to enable the driver, but "pseudo-device
> vport" is not valid kernel config. You enable the veb driver and that
> one driver provides both veb and vport interfaces. Another example of
> this is the gre driver which provides gre, egre, mgre, nvgre, and eoip
> interfaces.
> 
> > And finally, I added a mention that vport can be created with
> > ifconfig(8) so it's really obvious. Maybe it's too much and can be
> > removed.  
> 
> It should definitely be said. The other man pages for clonable
> interfaces generally have a paragraph like this:
> 
> .Nm gre ,
> .Nm mgre ,
> .Nm egre ,
> and
> .Nm nvgre
> interfaces can be created at runtime using the
> .Ic ifconfig iface Ns Ar N Ic create
> command or by setting up a
> .Xr hostname.if 5
> configuration file for
> .Xr netstart 8 .
> 
> I just noticed vether.4 is also missing a paragraph like that too :(
> 
> > comments? ok?  
> 
> Apart from it not being obvious where vport interfaces come from, is
> there anything else not obvious about veb?
> 

veb is fine to me, here is a diff that adds the ifconfig paragraph
to veb(4) and vether(4), I removed my first change from veb.

benno@ suggested I look at vether(4) to adapt the text related to
bridge(4) but I'm not sure how to rewrite it properly for veb(4).

Index: share/man/man4//veb.4
===================================================================
RCS file: /home/reposync/src/share/man/man4/veb.4,v
retrieving revision 1.2
diff -u -p -r1.2 veb.4
--- share/man/man4//veb.4       23 Feb 2021 11:43:41 -0000      1.2
+++ share/man/man4//veb.4       27 Oct 2021 06:28:45 -0000
@@ -43,6 +43,17 @@ From the perspective of the host network
 interface acts as a normal interface connected to an Ethernet
 network.
 .Pp
+A
+.Nm veb
+or
+.Nm vport
+interface can be created at runtime using the
+.Ic ifconfig iface Ns Ar N Ic create
+command or by setting up a
+.Xr hostname.if 5
+configuration file for
+.Xr netstart 8 .
+.Pp
 .Nm veb
 is a learning bridge that maintains a table of Ethernet addresses
 and the port that each address is reachable with.
Index: share/man/man4//vether.4
===================================================================
RCS file: /home/reposync/src/share/man/man4/vether.4,v
retrieving revision 1.5
diff -u -p -r1.5 vether.4
--- share/man/man4//vether.4    17 Oct 2017 22:47:58 -0000      1.5
+++ share/man/man4//vether.4    27 Oct 2021 06:29:54 -0000
@@ -30,6 +30,15 @@ standard network frames with an Ethernet
 for use as a member in a
 .Xr bridge 4 .
 .Pp
+A
+.Nm
+interface can be created at runtime using the
+.Ic ifconfig vether Ns Ar N Ic create
+command or by setting up a
+.Xr hostname.if 5
+configuration file for
+.Xr netstart 8 .
+.Pp
 To use
 .Nm
 the administrator needs to configure an address onto the interface

Reply via email to