From owner-svn-src-stable@FreeBSD.ORG  Thu Mar 19 23:06:46 2015
Return-Path: <owner-svn-src-stable@FreeBSD.ORG>
Delivered-To: svn-src-stable@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115])
 (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by hub.freebsd.org (Postfix) with ESMTPS id 4BB33BCA;
 Thu, 19 Mar 2015 23:06:46 +0000 (UTC)
Received: from svn.freebsd.org (svn.freebsd.org
 [IPv6:2001:1900:2254:2068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id 35E3F876;
 Thu, 19 Mar 2015 23:06:46 +0000 (UTC)
Received: from svn.freebsd.org ([127.0.1.70])
 by svn.freebsd.org (8.14.9/8.14.9) with ESMTP id t2JN6k7t034246;
 Thu, 19 Mar 2015 23:06:46 GMT (envelope-from markj@FreeBSD.org)
Received: (from markj@localhost)
 by svn.freebsd.org (8.14.9/8.14.9/Submit) id t2JN6kL4034245;
 Thu, 19 Mar 2015 23:06:46 GMT (envelope-from markj@FreeBSD.org)
Message-Id: <201503192306.t2JN6kL4034245@svn.freebsd.org>
X-Authentication-Warning: svn.freebsd.org: markj set sender to
 markj@FreeBSD.org using -f
From: Mark Johnston <markj@FreeBSD.org>
Date: Thu, 19 Mar 2015 23:06:46 +0000 (UTC)
To: src-committers@freebsd.org, svn-src-all@freebsd.org,
 svn-src-stable@freebsd.org, svn-src-stable-9@freebsd.org
Subject: svn commit: r280269 - stable/9/share/man/man9
X-SVN-Group: stable-9
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-src-stable@freebsd.org
X-Mailman-Version: 2.1.18-1
Precedence: list
List-Id: SVN commit messages for all the -stable branches of the src tree
 <svn-src-stable.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/svn-src-stable>,
 <mailto:svn-src-stable-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-src-stable/>
List-Post: <mailto:svn-src-stable@freebsd.org>
List-Help: <mailto:svn-src-stable-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-stable>,
 <mailto:svn-src-stable-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Thu, 19 Mar 2015 23:06:46 -0000

Author: markj
Date: Thu Mar 19 23:06:45 2015
New Revision: 280269
URL: https://svnweb.freebsd.org/changeset/base/280269

Log:
  MFC r279896:
  Document m_collapse().

Modified:
  stable/9/share/man/man9/mbuf.9
Directory Properties:
  stable/9/share/man/man9/   (props changed)

Modified: stable/9/share/man/man9/mbuf.9
==============================================================================
--- stable/9/share/man/man9/mbuf.9	Thu Mar 19 17:42:38 2015	(r280268)
+++ stable/9/share/man/man9/mbuf.9	Thu Mar 19 23:06:45 2015	(r280269)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd November 13, 2012
+.Dd March 11, 2015
 .Dt MBUF 9
 .Os
 .\"
@@ -136,6 +136,8 @@
 .Ft struct mbuf *
 .Fn m_defrag "struct mbuf *m0" "int how"
 .Ft struct mbuf *
+.Fn m_collapse "struct mbuf *m0" "int how" "int maxfrags"
+.Ft struct mbuf *
 .Fn m_unshare "struct mbuf *m0" "int how"
 .\"
 .Sh DESCRIPTION
@@ -975,6 +977,20 @@ depending on the caller's preference.
 This function is especially useful in network drivers, where
 certain long mbuf chains must be shortened before being added
 to TX descriptor lists.
+.It Fn m_collapse m0 how maxfrags
+Defragment an mbuf chain, returning a chain of at most
+.Fa maxfrags
+mbufs and clusters.
+If allocation fails or the chain cannot be collapsed as requested,
+.Dv NULL
+will be returned, with the original chain possibly modified.
+As with
+.Fn m_defrag ,
+.Fa how
+should be one of
+.Dv M_WAITOK
+or
+.Dv M_NOWAIT .
 .It Fn m_unshare m0 how
 Create a version of the specified mbuf chain whose
 contents can be safely modified without affecting other users.