From: Amos Jeffries <squid3@treenet.co.nz>
Date: Fri, 10 Jun 2011 19:08:00 +0000 (+1200)
Subject: Audit documentation fixes
X-Git-Tag: take08~55^2~124^2~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=50847dcac5a6ade1e37c506c5b9f8c85cfb85744;p=thirdparty%2Fsquid.git

Audit documentation fixes
---

diff --git a/src/cache_manager.cc b/src/cache_manager.cc
index 5f9664432a..fed773e6c5 100644
--- a/src/cache_manager.cc
+++ b/src/cache_manager.cc
@@ -91,6 +91,12 @@ CacheManager::registerProfile(const Mgr::ActionProfile::Pointer &profile)
     }
 }
 
+/**
+ \ingroup CacheManagerAPI
+ * Registers a C-style action, which is implemented as a pointer to a function
+ * taking as argument a pointer to a StoreEntry and returning void.
+ * Implemented via CacheManagerActionLegacy.
+ */
 void
 CacheManager::registerProfile(char const * action, char const * desc, OBJH * handler, int pw_req_flag, int atomic)
 {
diff --git a/src/comm/Connection.h b/src/comm/Connection.h
index 42519ad0bb..efdac6a1cd 100644
--- a/src/comm/Connection.h
+++ b/src/comm/Connection.h
@@ -79,7 +79,7 @@ namespace Comm {
  * object for state data. But a semantic equivalent for FD with easily
  * accessible cached properties not requiring repeated complex lookups.
  *
- * Connection properties may be changed until tehe connection is opened.
+ * Connection properties may be changed until the connection is opened.
  * Properties should be considered read-only outside of the Comm layer
  * code once the connection is open.
  *
@@ -176,9 +176,12 @@ inline std::ostream &
 operator << (std::ostream &os, const Comm::Connection &conn)
 {
     os << "FD " << conn.fd << " local=" << conn.local <<
-        " remote=" << conn.remote << " flags=" << conn.flags;
+        " remote=" << conn.remote;
+    if (flags != COMM_UNSET)
+        os << " flags=" << conn.flags;
 #if USE_IDENT
-    os << " IDENT::" << conn.rfc931;
+    if (*conn.rfc931)
+        os << " IDENT::" << conn.rfc931;
 #endif
     return os;
 }
diff --git a/src/pconn.cc b/src/pconn.cc
index 234eea0a2b..7058da6b84 100644
--- a/src/pconn.cc
+++ b/src/pconn.cc
@@ -135,11 +135,6 @@ IdleConnList::push(const Comm::ConnectionPointer &conn)
         for (int index = 0; index < size_; index++)
             theList_[index] = oldList[index];
 
-/* TODO: re-attach to MemPools.
-        if (size_ == PCONN_FDS_SZ)
-            pconn_fds_pool->freeOne(oldList);
-        else
-*/
         delete[] oldList;
     }
 
diff --git a/src/pconn.h b/src/pconn.h
index fc39a773d0..94cd4a4e96 100644
--- a/src/pconn.h
+++ b/src/pconn.h
@@ -61,7 +61,7 @@ public:
 
 private:
     /** List of connections we are holding.
-     * Sorted oldest to newest for most efficient speeds on pop() and findUsable()
+     * Sorted as FIFO list for most efficient speeds on pop() and findUsable()
      * The worst-case pop() and scans occur on timeout and link closure events
      * where timing is less critical. Occasional slow additions are okay.
      */