Squid 3.0.RC1 release notes

Squid Developers

This document contains the release notes for version 3.0 of Squid. Squid is a WWW Cache application developed by the National Laboratory @@ -117,8 +117,10 @@ Some has been dropped as they are not needed. Some has not yet been forward-port

The TCP_REFRESH_HIT and TCP_REFRESH_MISS log types have been replaced because they were misleading (all refreshes need to query the origin server, so they could never be hits). The following log types have been introduced to replace them:

TCP_REFRESH_UNMODIFIED: The requested object was cached but STALE. The IMS query for the object resulted in "304 not modified".
-
TCP_REFRESH_MODIFIED: The requested object was cached but STALE. The IMS query returned the new content.
+
TCP_REFRESH_UNMODIFIED: +
The requested object was cached but STALE. The IMS query for the object resulted in "304 not modified".
+
TCP_REFRESH_MODIFIED: +
The requested object was cached but STALE. The IMS query returned the new content.

See @@ -151,7 +153,8 @@ Some has been dropped as they are not needed. Some has not yet been forward-port

minimum_icp_query_timeout (msec)

 Default: 5
 
@@ -165,7 +168,8 @@ of a dynamic) timeout value. To set a fixed timeout see the

background_ping_rate

 Default: 10 seconds
 
@@ -175,7 +179,8 @@ have background-ping set.

httpd_accel_surrogate_id

 Default: unset
 
@@ -187,7 +192,8 @@ an identification token.

http_accel_surrogate_remote on|off

 Default: off
 
@@ -197,7 +203,8 @@ Set this to on to have squid behave as a remote surrogate.

esi_parser libxml2|expat|custom

 Default: custom
 
@@ -208,7 +215,8 @@ encodings.

email_err_data on|off

 Default: on
 
@@ -220,7 +228,8 @@ Syntax is <A HREF="mailto:%w%W">%w</A>

refresh_all_ims on|off

 Default: off
 
@@ -235,10 +244,13 @@ based on the age of the cached version.

request_header_access

Replaces the header_access directive of Squid-2.6 and earlier, but applies to requests only.

reply_header_access

Replaces the header_access directive of Squid-2.6 and earlier, but applies to replies only.

request_header_access

Replaces the header_access directive of Squid-2.6 and earlier, but applies to requests only.

reply_header_access

Replaces the header_access directive of Squid-2.6 and earlier, but applies to replies only.

icap_enable on|off

 Default: off
 
@@ -246,7 +258,8 @@ If you want to enable the ICAP module support, set this to on.

icap_preview_enable on|off

 Default: off
 
@@ -255,7 +268,8 @@ feature in Squid.

icap_preview_size

 Default: -1
 
@@ -265,7 +279,8 @@ basis by OPTIONS requests.

icap_default_options_ttl (seconds)

 Default: 60
 
@@ -274,7 +289,8 @@ an Options-TTL header.

icap_persistent_connections on|off

 Default: on
 
@@ -283,7 +299,8 @@ an ICAP server.

icap_send_client_ip on|off

 Default: off
 
@@ -291,7 +308,8 @@ This adds the header "X-Client-IP" to ICAP requests.

icap_send_client_username on|off

 Default: off
 
@@ -300,7 +318,8 @@ if proxy access is authentified.

icap_service

 Default: none
 
@@ -324,7 +343,8 @@ icap_service service_2 respmod_precache 0 icap://icap2.mydomain.net:1344/respmod

icap_class

 Default: none
 
@@ -339,7 +359,8 @@ icap class class_2 service_1 service_3

icap_access

 Default: none
 
@@ -363,7 +384,8 @@ icap_access class_1 allow all

accept_filter

 The name of an accept(2) filter to install on Squid's
 listen socket(s).  This feature is perhaps specific to
@@ -383,7 +405,8 @@ See the accf_http(9) man page.
 
 
 

-http_port
New options:
+
http_port

+New options:
 
     disable-pmtu-discovery=
       Control Path-MTU discovery usage:
@@ -409,13 +432,15 @@ See the accf_http(9) man page.
         
 
         
-
 https_port
Removed options:
+
 https_port

+Removed options:
 
     urlgroup=, not yet ported to Squid-3.
         
 
 
-
cache_peer
New options:
+
cache_peer

+New options:
 
      basetime=n
 
@@ -455,7 +480,8 @@ See the accf_http(9) man page.
         
 
 
-
cache_dir
Common options
+
cache_dir

+Common options
 
     no-store, replaces the older read-only option
 
@@ -478,7 +504,8 @@ See the accf_http(9) man page.
         
 
 
-
auth_param
Removed Basic auth option
+
auth_param

+Removed Basic auth option
 
     blankpasswor, not yet ported to squid-3.
     auth_param basic concurrency 0
@@ -492,7 +519,8 @@ See the accf_http(9) man page.
 
 
 
-
external_acl_type
New format specifications:
+
external_acl_type

+New format specifications:
 
     %URI          Requested URI
 
@@ -516,7 +544,8 @@ See the accf_http(9) man page.
 
 
 
-
refresh_pattern
New options:
+
refresh_pattern

+New options:
 
     ignore-no-store
     refresh-ims
@@ -533,7 +562,8 @@ See the accf_http(9) man page.
         
 
 
-
acl
New types:
+
acl

+New types:
 
     acl aclname http_status 200 301 500- 400-403 ...     # status code in reply
 
@@ -550,14 +580,16 @@ See the accf_http(9) man page.
         
 
 
-
short_icon_urls
New default:
+
short_icon_urls

+New default:
 
     Default: on
     (Old default: off)
         
 
 
-
delay_class
New delay classes:
+
delay_class

+New delay classes:
 
     class 4 Everything in a class 3 delay pool, with an
     additional limit on a per user basis. This
@@ -571,7 +603,8 @@ See the accf_http(9) man page.
 
 
 
-
htcp_port
New default to require the feature to be enabled in squid.conf:
+
htcp_port

+New default to require the feature to be enabled in squid.conf:
 
     Default: 0 (disabled)
     (Old default: 4827)
@@ -579,7 +612,8 @@ See the accf_http(9) man page.
 
 
 
-
icp_port
New default to require the feature to be enabled in squid.conf:
+
icp_port

+New default to require the feature to be enabled in squid.conf:
 
     Default: 0 (disabled)
     (Old default: 3130)
@@ -587,7 +621,8 @@ See the accf_http(9) man page.
 
 
 
-
snmp_port
New default to require the feature to be enabled in squid.conf:
+
snmp_port

+New default to require the feature to be enabled in squid.conf:
 
     Default: 0 (disabled)
     (Old default: 3401)
@@ -595,7 +630,8 @@ See the accf_http(9) man page.
 
 
 
-
logformat
New format tags:
+
logformat

+New format tags:
 
     rp      Request URL-Path excluding hostname
 
@@ -617,7 +653,8 @@ See the accf_http(9) man page.
 
 
 
-
reply_body_max_size
Syntax changed:
+
reply_body_max_size

+Syntax changed:
 
     reply_body_max_size size [acl acl...]
         
@@ -625,7 +662,8 @@ See the accf_http(9) man page.
 
 allow/deny no longer used.
 
-url_rewrite_program
No urlgroup support in either requests or responese
+
url_rewrite_program

+No urlgroup support in either requests or responese
 
 
 
@@ -636,19 +674,32 @@ See the accf_http(9) man page.
 
 
 

-broken_vary_encoding
Not yet ported to Squid-3.
-
cache_vary
Not yet ported to Squid-3.
-
collapsed_forwarding
Not yet ported to Squid-3.
-
follow_x_forwarded_for
Not yet ported to Squid-3.
-
*_uses_indirect_client
Not yet ported to Squid-3.
-
error_map
Not yet ported to Squid-3.
-
header_access
This has been replaced by request_header_access and reply_header_access
-
http_access2
Not yet ported to Squid-3.
-
httpd_accel_no_pmtu_disc
Replaced by disable-pmtu-discovery http_port option
-
location_rewrite_*
Not yet ported to Squid-3.
-
refresh_stale_hit
Not yet ported to Squid-3.
-
umask
Not yet ported to Squid-3.
-
wais_relay_*
equivalent to cache_peer + cache_peer_access.
+
broken_vary_encoding

+Not yet ported to Squid-3.
+
cache_vary

+Not yet ported to Squid-3.
+
collapsed_forwarding

+Not yet ported to Squid-3.
+
follow_x_forwarded_for

+Not yet ported to Squid-3.
+
*_uses_indirect_client

+Not yet ported to Squid-3.
+
error_map

+Not yet ported to Squid-3.
+
header_access

+This has been replaced by request_header_access and reply_header_access
+
http_access2

+Not yet ported to Squid-3.
+
httpd_accel_no_pmtu_disc

+Replaced by disable-pmtu-discovery http_port option
+
location_rewrite_*

+Not yet ported to Squid-3.
+
refresh_stale_hit

+Not yet ported to Squid-3.
+
umask

+Not yet ported to Squid-3.
+
wais_relay_*

+equivalent to cache_peer + cache_peer_access.
 
 
 
@@ -677,27 +728,33 @@ See the accf_http(9) man page.
 
 
 

---enable-shared[=PKGS]
Build shared libraries. The default is to build without.
+
--enable-shared[=PKGS]

+Build shared libraries. The default is to build without.
 
-
--enable-static[=PKGS]
Build static libraries. The default is on.
+
--enable-static[=PKGS]

+Build static libraries. The default is on.
 
-
--enable-fast-install[=PKGS]

+
--enable-fast-install[=PKGS]

+
 
 Optimize for fast installation
         default: yes
 
 
 
-
--disable-libtool-lock
Avoid locking (might break parallel builds)
+
--disable-libtool-lock

+Avoid locking (might break parallel builds)
 
-
--disable-optimizations
Don't compile Squid with compiler optimizations enabled.
+
--disable-optimizations

+Don't compile Squid with compiler optimizations enabled.
 Optimization is good for production builds, but not
 good for debugging. During development, use
 --disable-optimizations to reduce compilation times
 and allow easier debugging. This option implicitly
 also enables --disable-inline
 
-
--disable-inline
Don't compile trivial methods as inline. Squid
+
--disable-inline

+Don't compile trivial methods as inline. Squid
 is coded with much of the code able to be inlined.
 Inlining is good for production builds, but not
 good for development. During development, use
@@ -707,15 +764,18 @@ production builds, or load tests, use
 --enable-inline to have squid make all trivial
 methods inlinable by the compiler.
 
-
--enable-debug-cbdata
Provide some debug information in cbdata
+
--enable-debug-cbdata

+Provide some debug information in cbdata
 
-
--enable-disk-io=\"list of modules\"
Build support for the list of disk I/O modules.
+
--enable-disk-io=\"list of modules\"

+Build support for the list of disk I/O modules.
 The default is only to build the "Blocking" module.
 See src/DiskIO for a list of available modules, or
 Programmers Guide for details on how to build your
 custom disk module.
 
-
--enable-esi
Enable ESI for accelerators. Requires libexpat.
+
--enable-esi

+Enable ESI for accelerators. Requires libexpat.
 Enabling ESI will cause squid to follow the Edge
 Acceleration Specification (www.esi.org). This
 causes squid to IGNORE client Cache-Control headers.
@@ -723,23 +783,30 @@ causes squid to IGNORE client Cache-Control headers.
 proxy, ONLY use it in a squid configured for
 webserver acceleration.
 
-
--enable-icap-client
Enable the ICAP client.
+
--enable-icap-client

+Enable the ICAP client.
 
-
--disable-snmp
Disable SNMP monitoring support which is now built by default.
+
--disable-snmp

+Disable SNMP monitoring support which is now built by default.
 
-
--disable-htcp
Disable HTCP protocol support which is now built by default.
+
--disable-htcp

+Disable HTCP protocol support which is now built by default.
 
-
--enable-kqueue
Enable kqueue() support. Marked as experimental in 3.0.
+
--enable-kqueue

+Enable kqueue() support. Marked as experimental in 3.0.
 
-
--enable-ipfw-transparent
Enable Transparent Proxy support for systems
+
--enable-ipfw-transparent

+Enable Transparent Proxy support for systems
 using FreeBSD IPFW style redirection.
 
-
--disable-mempools
Disable memPools. Note that this option now simply sets the
+
--disable-mempools

+Disable memPools. Note that this option now simply sets the
 default behaviour. Specific classes can override this at runtime, and
 only lib/MemPool.c needs to be altered to change the squid-wide
 default for all classes.
 
-
--enable-cpu-profiling
This option allows you to see which internal functions
+
--enable-cpu-profiling

+This option allows you to see which internal functions
 in Squid are consuming how much CPU. Compiles in probes
 that measure time spent in probed functions. Needs
 source modifications to add new probes. This is meant
@@ -749,16 +816,21 @@ of Squid internal functions.
 you shouldn't enable this, as overhead added, although
 small, is still overhead. See lib/Profiler.c for more.
 
-
--with-gnu-ld
Assume the C compiler uses GNU ld. The default is to auto-detect.
+
--with-gnu-ld

+Assume the C compiler uses GNU ld. The default is to auto-detect.
 
-
--with-pic
Try to use only PIC/non-PIC objects. The default is to use both.
+
--with-pic

+Try to use only PIC/non-PIC objects. The default is to use both.
 
-
--with-tags[=TAGS]
Include additional configurations. The default is automatic.
+
--with-tags[=TAGS]

+Include additional configurations. The default is automatic.
 
-
--with-default-user=USER
Sets the default System User account for squid permissions.
+
--with-default-user=USER

+Sets the default System User account for squid permissions.
 The default is 'nobody' as in other releases of squid.
 
-
--with-cppunit-basedir=[PATH]
Path where the cppunit headers and libraries are found
+
--with-cppunit-basedir=[PATH]

+Path where the cppunit headers and libraries are found
 for unit testing. The default is automatic detection.
 NOTE: Since 3.0-PRE6 and 2.6STABLE14 squid no longer comes
 bundled with CPPUnit. Compile-time validation will be disabled
@@ -770,33 +842,42 @@ if it is not installed on your system.
 
 
 

---enable-carp
CARP support is now built by default.
---disable-carp can be used to buidl without it.
+
--enable-carp

+CARP support is now built by default.
+--disable-carp can be used to build without it.
 
-
--enable-htcp
HTCP protocol support is now built by default.
+
--enable-htcp

+HTCP protocol support is now built by default.
 Use --disable-htcp to build without it.
 
-
--enable-snmp
SNMP monitoring is now build by default.
+
--enable-snmp

+SNMP monitoring is now build by default.
 Use --disable-snmp to build without it.
 
-
--enable-heap-replacement
Please use --enable-removal-policies directive instead.
+
--enable-heap-replacement

+Please use --enable-removal-policies directive instead.
 
-
--with-maxfd=N
Replaced by --with-filedescriptors=N
+
--with-maxfd=N

+Replaced by --with-filedescriptors=N
 Override maximum number of filedescriptors. Useful
 if you build as another user who is not privileged
 to use the number of filedescriptors you want the
 resulting binary to support
 
-
--enable-select
Deprecated.
+
--enable-select

+Deprecated.
 Automatic checks will enable best I/O loop method available.
 
-
--enable-epoll
Deprecated.
+
--enable-epoll

+Deprecated.
 Automatic checks will enable best I/O loop method available.
 
-
--enable-poll
Deprecated.
+
--enable-poll

+Deprecated.
 Automatic checks will enable best I/O loop method available.
 
-
--enable-kqueue
kqueue support is marked Experimental in Squid 3.0. Known to have some issues under load.
+
--enable-kqueue

+kqueue support is marked Experimental in Squid 3.0. Known to have some issues under load.
 
 
 
@@ -806,11 +887,14 @@ Automatic checks will enable best I/O loop method available.
 porting one of these from Squid-2 to Squid-3 is most welcome.
 
 

---enable-devpoll
Support for Solaris /dev/poll
+
--enable-devpoll

+Support for Solaris /dev/poll
 
-
--enable-select-simple
Basic POSIX select() loop without any binary fd_set optimizations.
+
--enable-select-simple

+Basic POSIX select() loop without any binary fd_set optimizations.
 
-
--enable-follow-x-forwarded-for
Support following the X-Forwarded-For HTTP header for determining the
+
--enable-follow-x-forwarded-for

+Support following the X-Forwarded-For HTTP header for determining the
 client IP address
 
 
@@ -820,13 +904,20 @@ client IP address
 The following configure options have been removed.
 
 

---enable-dlmalloc
Most OS:es have good malloc implementations these days, and the version we used to ship with Squid was very very old..
-
--enable-mempool-debug
Debug option, not needed and therefore removed.
-
--enable-forward-log
Rarely used extra log file. Removed.
-
--enable-multicast-miss
Rarely used feature, and multicast ICP acheives almost the same result. Removed.
-
--enable-coss-aio-ops
Specific to the COSS implementation in Squid-2
-
--enable-large-cache-files
Now enabled by default. Configure option was redundant and therefore removed.
-
--enable-truncate
Known to cause race conditions where cache objects may get corrupted, and this for at most a marginal performance improvement. Removed.
+
--enable-dlmalloc

+Most OS:es have good malloc implementations these days, and the version we used to ship with Squid was very very old..
+
--enable-mempool-debug

+Debug option, not needed and therefore removed.
+
--enable-forward-log

+Rarely used extra log file. Removed.
+
--enable-multicast-miss

+Rarely used feature, and multicast ICP acheives almost the same result. Removed.
+
--enable-coss-aio-ops

+Specific to the COSS implementation in Squid-2
+
--enable-large-cache-files

+Now enabled by default. Configure option was redundant and therefore removed.
+
--enable-truncate

+Known to cause race conditions where cache objects may get corrupted, and this for at most a marginal performance improvement. Removed.
 
 
 
diff --git a/doc/release-notes/release-3.0.sgml b/doc/release-notes/release-3.0.sgml
index 3e510429c3..08c09abb3c 100644
--- a/doc/release-notes/release-3.0.sgml
+++ b/doc/release-notes/release-3.0.sgml
@@ -2,7 +2,7 @@
 
 Squid 3.0.RC1 release notes
 Squid Developers
-$Id: release-3.0.sgml,v 1.30 2007/11/18 17:23:01 serassio Exp $
+$Id: release-3.0.sgml,v 1.31 2007/12/14 05:34:16 amosjeffries Exp $
 
 
 This document contains the release notes for version 3.0 of Squid.
@@ -714,7 +714,7 @@ This section gives an account of those changes in three categories:
 
 	--enable-carp
 	CARP support is now built by default.
-	 --disable-carp can be used to buidl without it.
+	 --disable-carp can be used to build without it.
 
 	--enable-htcp
 	HTCP protocol support is now built by default.