[or-cvs] r17704: {tor} Doc RRS_DONT_REMOVE_OLD; improve router_rebuild_store docume (tor/trunk/src/or)

[nickm at seul.org]

Author: nickm
Date: 2008-12-19 13:51:44 -0500 (Fri, 19 Dec 2008)
New Revision: 17704

Modified:
   tor/trunk/src/or/routerlist.c
Log:
Doc RRS_DONT_REMOVE_OLD; improve router_rebuild_store documentation.

Modified: tor/trunk/src/or/routerlist.c
===================================================================
--- tor/trunk/src/or/routerlist.c	2008-12-19 18:51:40 UTC (rev 17703)
+++ tor/trunk/src/or/routerlist.c	2008-12-19 18:51:44 UTC (rev 17704)
@@ -598,12 +598,11 @@
 #define RRS_FORCE 1
 #define RRS_DONT_REMOVE_OLD 2
 
-/** If the journal is too long, or if RRS_FORCE is set in <b>flags</b>, then
- * atomically replace the router store with the routers currently in our
- * routerlist, and clear the journal.  Return 0 on success, -1 on failure.
- *
- * If <b>extrainfo</b> is true, rebuild the extrainfo store; else rebuild the
- * router descriptor store. [XXX021 this sentence refers to bad args]
+/** If the journal of <b>store</b> is too long, or if RRS_FORCE is set in
+ * <b>flags</b>, then atomically replace the saved router store with the
+ * routers currently in our routerlist, and clear the journal.  Unless
+ * RRS_DONT_REMOVE_OLD is set in <b>flags</b>, delete expired routers before
+ * rebuilding the store.  Return 0 on success, -1 on failure.
  */
 static int
 router_rebuild_store(int flags, desc_store_t *store)