svn commit: r238093 - head/share/man/man9

[Gleb Smirnoff]

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.