Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 3 May 2018 17:52:40 +0000 (UTC)
From:      Benno Rice <benno@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org
Subject:   svn commit: r333220 - head/share/man/man9
Message-ID:  <201805031752.w43HqeBG016468@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: benno
Date: Thu May  3 17:52:40 2018
New Revision: 333220
URL: https://svnweb.freebsd.org/changeset/base/333220

Log:
  Add a stub manual page for iflib(9).
  
  Currently 'man -k iflib' would find you the right pages for iflib
  documentation, namely iflibdd(9) and iflibdi(9) but 'man iflib' would leave
  you in the dark. This allows both approaches to find the relevant
  documentation.
  
  Reviewed by:	kmacy, shurd
  Sponsored by:	iXsystems, Inc.
  Differential Revision:	https://reviews.freebsd.org/D15219

Added:
  head/share/man/man9/iflib.9   (contents, props changed)
Modified:
  head/share/man/man9/Makefile

Modified: head/share/man/man9/Makefile
==============================================================================
--- head/share/man/man9/Makefile	Thu May  3 17:49:26 2018	(r333219)
+++ head/share/man/man9/Makefile	Thu May  3 17:52:40 2018	(r333220)
@@ -163,6 +163,7 @@ MAN=	accept_filter.9 \
 	ieee80211_regdomain.9 \
 	ieee80211_scan.9 \
 	ieee80211_vap.9 \
+	iflib.9 \
 	iflibdd.9 \
 	iflibdi.9 \
 	iflibtxrx.9 \

Added: head/share/man/man9/iflib.9
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/share/man/man9/iflib.9	Thu May  3 17:52:40 2018	(r333220)
@@ -0,0 +1,41 @@
+.\" $FreeBSD$
+.Dd May 3, 2018
+.Dt IFLIB 9
+.Os
+.Sh NAME
+.Nm iflib
+.Nd Network Interface Driver Framework
+.Sh DESCRIPTION
+.Nm
+is a framework for writing network interface drivers for FreeBSD.
+It is designed to remove a large amount of the boilerplate that is often
+needed for modern network interface devices, allowing driver authors to
+focus on the specific code needed for their hardware.
+.Pp
+There are three logical components to
+.Nm
+each of which is described in its own manual page.
+These are:
+.Bl -tag -width ".Xr iflibtxrx 9"
+.It Xr iflibdi 9
+Device-independent functions, used to integrate
+.Nm
+into the rest of the
+.Fx
+networking stack.
+.It Xr iflibdd 9
+Device-dependent functions, used when writing new
+.Nm
+based drivers.
+.It Xr iflibtxrx 9
+Device-dependent transmit and receive functions, used when writing new
+.Nm
+based drivers.
+.Sh SEE ALSO
+.Xr iflibdd 9 ,
+.Xr iflibdi 9 ,
+.Xr iflibtxrx 9 ,
+.Xr ifnet 9
+.Sh AUTHORS
+.An Benno Rice Aq Mt benno@FreeBSD.org
+



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201805031752.w43HqeBG016468>