Added ICAP notes.

Polished "Major new features" list to downplay the importance of ESI and
related code changes (because nobody currently supports ESI modifications
amd they have known bugs).

Did not update the .html version for the lack of linuxdoc installation.

diff --git a/doc/release-notes/release-3.0.sgml b/doc/release-notes/release-3.0.sgml
index 97429b5063c5c5b451f27650e15bf3cdca2b102f..ed4d3bca272caea138bf9c86a9fb7a41ab786e9d 100644 (file)
--- a/doc/release-notes/release-3.0.sgml
+++ b/doc/release-notes/release-3.0.sgml
@@ -2,7 +2,7 @@
 <article>\r
 <title>Squid 3.0.PRE7 release notes</title>\r
 <author>Squid Developers</author>\r
-<date>$Id: release-3.0.sgml,v 1.26 2007/09/03 05:33:26 amosjeffries Exp $</date>\r
+<date>$Id: release-3.0.sgml,v 1.27 2007/09/17 17:54:23 rousskov Exp $</date>\r
 \r
 <abstract>\r
 This document contains the release notes for version 3.0 of Squid.\r
@@ -40,17 +40,38 @@ Squid 3.0 represents a major rewrite of Squid and has a number of new features.
 The most important of these are:\r
 \r
 <itemize>\r
-       <item>Edge Side Includes (ESI) implementation (www.esi.org)\r
-       <item>ICAP implementation (www.i-cap.org)\r
-       <item>Internal client streams concept enabling the implementations of ESI and ICAP.\r
        <item>Code converted to C++, with significant internal restructuring and rewrites.\r
+       <item>ICAP implementation (RFC 3507 and www.icap-forum.org)\r
+       <item>Edge Side Includes (ESI) implementation (www.esi.org)\r
 </itemize>\r
 \r
 Most user-facing changes are reflected in squid.conf (see below).\r
 \r
 <sect2>Internet Content Adaptation Protocol (ICAP)\r
 \r
-<p>TO BE WRITTEN\r
+<p>Squid 3.0 supports ICAP/1.0. To enable ICAP support, use the --enable-icap-client ./configure option and icap_enable squid.conf option. You will also need to configure ICAP services in your squid.conf using icap_service, icap_class, and icap_access options. The following example instructs Squid to talk to two ICAP services, one for request and one for response adaptation:\r
+\r
+<verb>\r
+icap_enable on\r
+icap_service service_req reqmod_precache 1 icap://127.0.0.1:1344/request\r
+icap_service service_resp respmod_precache 0 icap://127.0.0.1:1344/response\r
+icap_class class_req service_req\r
+icap_class class_resp service_resp\r
+icap_access class_req allow all\r
+icap_access class_resp allow all\r
+</verb>\r
+\r
+<p>Please see squid.conf.default for more details about these and many other icap_* options.\r
+\r
+<p>Squid supports pre-cache request and pre-cache response vectoring points. The following ICAP features are supported: message preview, 204 responses outside of preview, request satisfaction, X-Transfer-* negotiation, persistent ICAP connections, client IP/credentials sharing, and optional bypass of certain service failures.\r
+\r
+<p>No more than one ICAP service can be applied to an HTTP message. In other words, chaining or load balancing multiple services is not yet supported.\r
+\r
+<p>Proxy-directed data trickling and patience pages are not supported yet.\r
+\r
+<p>Following ICAP requirements, Squid never performs HTTP message adaptation without a successful and fresh ICAP OPTIONS response on file. A REQMOD or RESPMOD request will not be sent to a configured ICAP service until Squid receives a valid OPTIONS response from that service. If a service malfunctions or goes down, Squid may stop talking to the service for a while. Several squid.conf options can be used to tune the failure bypass algorithm (e.g., icap_service_failure_limit and icap_service_revival_delay). \r
+\r
+<p>The bypass parameter of the icap_service squid.conf option determines whether Squid will try to bypass service failures. Most connectivity and preview-stage failures can be bypassed.\r
 \r
 <p>More information about ICAP can be found from the ICAP-forum website <url url="http://www.icap-forum.org">\r
 \r