Updated FwdState::updateHierarchyInfo() documentation with Henrik's comment

that was about to be lost in a closed bug #2391 report.

diff --git a/src/forward.cc b/src/forward.cc
index 18e3fee05a08db3090853098f29938c99972ca1a..9fc1cbe56bde442b3e5e9c8d91fdff6d45c9fd0a 100644 (file)
--- a/src/forward.cc
+++ b/src/forward.cc
@@ -1244,6 +1244,21 @@ FwdState::serversFree(FwdServer ** FSVR)
     }
 }
 
+/** From Comment #5 by Henrik Nordstrom made at
+http://www.squid-cache.org/bugs/show_bug.cgi?id=2391 on 2008-09-19
+
+updateHierarchyInfo should be called each time a new path has been
+selected or when more information about the path is available (i.e. the
+server IP), and when it's called it needs to be given reasonable
+arguments describing the now selected path..
+
+It does not matter from a functional perspective if it gets called a few
+times more than what is really needed, but calling it too often may
+obviously hurt performance.
+
+\todo Current code looks fine, even if using !fs->_peer as condition 
+instead of HIER_DIRECT would be clearer.
+*/
 // updates HierarchyLogEntry, guessing nextHop and its format
 void
 FwdState::updateHierarchyInfo()