[Midnightbsd-cvs] src [8037] trunk/share/man/man9/rtalloc.9: document RO_RTFREE macro

[laffer1 at midnightbsd.org]

Revision: 8037
          http://svnweb.midnightbsd.org/src/?rev=8037
Author:   laffer1
Date:     2016-09-15 16:45:25 -0400 (Thu, 15 Sep 2016)
Log Message:
-----------
document RO_RTFREE macro

Modified Paths:
--------------
    trunk/share/man/man9/rtalloc.9

Modified: trunk/share/man/man9/rtalloc.9
===================================================================
--- trunk/share/man/man9/rtalloc.9	2016-09-15 20:45:01 UTC (rev 8036)
+++ trunk/share/man/man9/rtalloc.9	2016-09-15 20:45:25 UTC (rev 8037)
@@ -28,7 +28,7 @@
 .\"
 .\" $MidnightBSD$
 .\"
-.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 @@
 .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.