From owner-svn-src-all@FreeBSD.ORG  Wed Jul  4 07:42:12 2012
Return-Path: <owner-svn-src-all@FreeBSD.ORG>
Delivered-To: svn-src-all@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id C2FD7106566C;
	Wed,  4 Jul 2012 07:42:12 +0000 (UTC)
	(envelope-from glebius@FreeBSD.org)
Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:4f8:fff6::2c])
	by mx1.freebsd.org (Postfix) with ESMTP id ADF828FC0A;
	Wed,  4 Jul 2012 07:42:12 +0000 (UTC)
Received: from svn.freebsd.org (localhost [127.0.0.1])
	by svn.freebsd.org (8.14.4/8.14.4) with ESMTP id q647gCtk096243;
	Wed, 4 Jul 2012 07:42:12 GMT (envelope-from glebius@svn.freebsd.org)
Received: (from glebius@localhost)
	by svn.freebsd.org (8.14.4/8.14.4/Submit) id q647gC7k096241;
	Wed, 4 Jul 2012 07:42:12 GMT (envelope-from glebius@svn.freebsd.org)
Message-Id: <201207040742.q647gC7k096241@svn.freebsd.org>
From: Gleb Smirnoff <glebius@FreeBSD.org>
Date: Wed, 4 Jul 2012 07:42:12 +0000 (UTC)
To: src-committers@freebsd.org, svn-src-all@freebsd.org,
	svn-src-head@freebsd.org
X-SVN-Group: head
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Cc: 
Subject: svn commit: r238093 - head/share/man/man9
X-BeenThere: svn-src-all@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: "SVN commit messages for the entire src tree \(except for &quot;
	user&quot; and &quot; projects&quot; \)" <svn-src-all.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-all>,
	<mailto:svn-src-all-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-src-all>
List-Post: <mailto:svn-src-all@freebsd.org>
List-Help: <mailto:svn-src-all-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-all>,
	<mailto:svn-src-all-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Wed, 04 Jul 2012 07:42:12 -0000

Author: glebius
Date: Wed Jul  4 07:42:12 2012
New Revision: 238093
URL: http://svn.freebsd.org/changeset/base/238093

Log:
  Document RO_RTFREE() macro.

Modified:
  head/share/man/man9/rtalloc.9

Modified: head/share/man/man9/rtalloc.9
==============================================================================
--- head/share/man/man9/rtalloc.9	Wed Jul  4 07:37:53 2012	(r238092)
+++ head/share/man/man9/rtalloc.9	Wed Jul  4 07:42:12 2012	(r238093)
@@ -28,7 +28,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd December 14, 2011
+.Dd July 4, 2012
 .Dt RTALLOC 9
 .Os
 .Sh NAME
@@ -52,6 +52,7 @@
 .Fn RT_UNLOCK "struct rt_entry *rt"
 .Fn RT_ADDREF "struct rt_entry *rt"
 .Fn RT_REMREF "struct rt_entry *rt"
+.Fn RO_RTFREE "struct route *ro"
 .Ft void
 .Fn rtfree "struct rt_entry *rt"
 .Ft "struct rtentry *"
@@ -203,6 +204,14 @@ Its usage is contrary to
 .Fn RT_ADDREF .
 .Pp
 The
+.Fn RO_RTFREE
+macro is used to free route entry that is referenced by struct route.
+At certain circumstances the latter may not hold a reference on rtentry,
+and
+.Fn RO_RTFREE
+treats such routes correctly.
+.Pp
+The
 .Fn rtfree
 function does the actual free of the routing table entry, and shouldn't
 be called directly by facilities, that just perform routing table lookups.