[or-cvs] r9906: Add documentation for make_old argument to routerlist functi (in tor/trunk: . src/or)

[nickm@xxxxxxxx]

Author: nickm
Date: 2007-03-26 10:08:29 -0400 (Mon, 26 Mar 2007)
New Revision: 9906

Modified:
   tor/trunk/
   tor/trunk/src/or/routerlist.c
Log:
 r12653@Kushana:  nickm | 2007-03-25 18:21:38 -0400
 Add documentation for make_old argument to routerlist functions.



Property changes on: tor/trunk
___________________________________________________________________
 svk:merge ticket from /tor/trunk [r12653] on c95137ef-5f19-0410-b913-86e773d04f59

Modified: tor/trunk/src/or/routerlist.c
===================================================================
--- tor/trunk/src/or/routerlist.c	2007-03-26 14:08:18 UTC (rev 9905)
+++ tor/trunk/src/or/routerlist.c	2007-03-26 14:08:29 UTC (rev 9906)
@@ -1647,7 +1647,8 @@
  * which to remove.  We fill the gap in rl->routers with a later element in
  * the list, if any exists. <b>ri</b> is freed.
  *
- * DOCDOC make_old */
+ * If <b>make_old</b> is true, instead of deleting the router, we try adding
+ * it to rl-&gt;old_routers. */
 void
 routerlist_remove(routerlist_t *rl, routerinfo_t *ri, int idx, int make_old)
 {
@@ -1703,7 +1704,8 @@
  * search over the list to decide which to remove.  We put ri_new in the same
  * index as ri_old, if possible.  ri is freed as appropriate.
  *
- * DOCDOC make_old */
+ * If <b>make_old</b> is true, instead of deleting the router, we try adding
+ * it to rl-&gt;old_routers. */
 static void
 routerlist_replace(routerlist_t *rl, routerinfo_t *ri_old,
                    routerinfo_t *ri_new, int idx, int make_old)