---------------------
PatchSet 6074 
Date: 2007/11/05 10:32:04
Author: amosjeffries
Branch: docs
Tag: (none) 
Log:
Pull more pinger doc out from configure.in

Members: 
	src/pinger.cc:1.15.2.1->1.15.2.2 

Index: squid3/src/pinger.cc
===================================================================
RCS file: /cvsroot/squid-sf//squid3/src/pinger.cc,v
retrieving revision 1.15.2.1
retrieving revision 1.15.2.2
diff -u -r1.15.2.1 -r1.15.2.2
--- squid3/src/pinger.cc	27 Oct 2007 10:11:22 -0000	1.15.2.1
+++ squid3/src/pinger.cc	5 Nov 2007 10:32:04 -0000	1.15.2.2
@@ -1,5 +1,5 @@
 /*
- * $Id: pinger.cc,v 1.15.2.1 2007/10/27 10:11:22 amosjeffries Exp $
+ * $Id: pinger.cc,v 1.15.2.2 2007/11/05 10:32:04 amosjeffries Exp $
  *
  * DEBUG: section 42    ICMP Pinger program
  * AUTHOR: Duane Wessels
@@ -50,6 +50,17 @@
  *   Rather than require Squid to be started as root, we prefer
  *   to have the smaller and simpler pinger program installed
  *   with setuid permissions.
+ *
+ \par
+ *   If you want to use Squid's ICMP features (highly recommended!)
+ *   When USE_ICMP is defined, Squid will send ICMP pings
+ *   to origin server sites.
+ *   This information is used in numerous ways:
+ \li  - Sent in ICP replies so neighbor caches know how close
+ *      you are to the source.
+ \li  - For finding the closest instance of a URN.
+ \li  - With the 'test_reachability' option.  Squid will return
+ *      ICP_OP_MISS_NOFETCH for sites which it cannot ping.
  */
 
 #include "squid.h"