]> git.ipfire.org Git - thirdparty/squid.git/commitdiff
Release Notes for Squid-3.5
authorAmos Jeffries <squid3@treenet.co.nz>
Sat, 7 Dec 2013 07:49:29 +0000 (00:49 -0700)
committerAmos Jeffries <squid3@treenet.co.nz>
Sat, 7 Dec 2013 07:49:29 +0000 (00:49 -0700)
doc/release-notes/Makefile
doc/release-notes/release-3.5.sgml [new file with mode: 0644]

index e96e81dfced8e71c534315e319988cd61c4223b0..14d47d8d26530017740a72ad4873b710d73703a4 100644 (file)
@@ -1,6 +1,6 @@
-all: release-3.4.html
+all: release-3.5.html
 
-DOC= release-3.4
+DOC= release-3.5
 
 $(DOC).ps: $(DOC).sgml
        linuxdoc -B latex -o ps $(DOC)
diff --git a/doc/release-notes/release-3.5.sgml b/doc/release-notes/release-3.5.sgml
new file mode 100644 (file)
index 0000000..d1837d4
--- /dev/null
@@ -0,0 +1,233 @@
+<!doctype linuxdoc system>
+<article>
+<title>Squid 3.5.0.0 release notes</title>
+<author>Squid Developers</author>
+
+<abstract>
+This document contains the release notes for version 3.5 of Squid.
+Squid is a WWW Cache application developed by the National Laboratory
+for Applied Network Research and members of the Web Caching community.
+</abstract>
+
+<toc>
+
+<sect>Notice
+<p>
+The Squid Team are pleased to announce the release of Squid-3.5.0.0 for testing.
+
+This new release is available for download from <url url="http://www.squid-cache.org/Versions/v3/3.5/"> or the
+ <url url="http://www.squid-cache.org/Mirrors/http-mirrors.html" name="mirrors">.
+
+While this release is not deemed ready for production use, we believe it is ready for wider testing by the community.
+
+We welcome feedback and bug reports. If you find a bug, please see <url url="http://wiki.squid-cache.org/SquidFaq/BugReporting">
+ for how to submit a report with a stack trace.
+
+<sect1>Known issues
+<p>
+Although this release is deemed good enough for use in many setups, please note the existence of 
+<url url="http://bugs.squid-cache.org/buglist.cgi?query_format=advanced&amp;product=Squid&amp;bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;version=3.5" name="open bugs against Squid-3.5">.
+
+<sect1>Changes since earlier releases of Squid-3.5
+<p>
+The 3.5 change history can be <url url="http://www.squid-cache.org/Versions/v3/3.5/changesets/" name="viewed here">.
+
+
+<sect>Major new features since Squid-3.4
+<p>Squid 3.5 represents a new feature release above 3.4.
+
+<p>The most important of these new features are:
+<itemize>
+       <item>Support libecap v1.0
+</itemize>
+
+Most user-facing changes are reflected in squid.conf (see below).
+
+
+<sect1>Support libecap v1.0
+<p>Details at <url url="http://wiki.squid-cache.org/Features/BLAH">.
+
+<p>The new libecap version allows Squid to better check the version of
+  the eCAP adapter being loaded as well as the version of the eCAP library
+  being used.
+
+<p>Squid-3.5 can support eCAP adapters built with libecap v1.0,
+   but no longer supports adapters built with earlier libecap versions
+   due to API changes.
+
+
+<sect>Changes to squid.conf since Squid-3.4
+<p>
+There have been changes to Squid's configuration file since Squid-3.4.
+
+<p>Squid supports reading configuration option parameters from external
+   files using the syntax <em>parameters("/path/filename")</em>. For example:
+<verb>
+    acl whitelist dstdomain parameters("/etc/squid/whitelist.txt")
+</verb>
+
+<p>There have also been changes to individual directives in the config file.
+
+This section gives a thorough account of those changes in three categories:
+
+<itemize>
+       <item><ref id="newtags" name="New tags">
+       <item><ref id="modifiedtags" name="Changes to existing tags">
+       <item><ref id="removedtags" name="Removed tags">
+</itemize>
+<p>
+
+<sect1>New tags<label id="newtags">
+<p>
+<descrip>
+       <p><em>There are no removed squid.conf directives in Squid-3.5.</em>
+
+</descrip>
+
+<sect1>Changes to existing tags<label id="modifiedtags">
+<p>
+<descrip>
+       <tag>acl</tag>
+       <p>New type <em>adaptation_service</em> to match the name of any
+          icap_service, ecap_service, adaptation_service_set, or
+          adaptation_service_chain that Squid has used (or attempted to use)
+          for the HTTP transaction so far.
+
+       <tag>auth_param</tag>
+       <p>New parameter <em>key_extras</em> to send additional parameters to
+          the authentication helper.
+
+       <tag>forward_max_tries</tag>
+       <p>Default value increased to <em>25 destinations/em> to allow better
+          contact and IPv4 failover with domains using long lists of IPv6
+          addresses.
+
+       <tag>http_port</tag>
+       <p><em>protocol=</em> option altered to accept protocol version details.
+          Currently supported values are: HTTP, HTTP/1.1, HTTPS, HTTPS/1.1
+
+       <tag>logformat</tag>
+       <p>New format code <em>%credentials</em> to log the client credentials
+          token.
+       <p>New format code <em>%tS</em> to log transaction start time in
+          "seconds.milliseconds" format, similar to the existing access.log
+          "current time" field (%ts.%03tu) which logs the corresponding
+          transaction finish time.
+
+</descrip>
+
+<sect1>Removed tags<label id="removedtags">
+<p>
+<descrip>
+       <tag>cache_dir</tag>
+       <p><em>COSS</em> storage type is formally replaced by Rosk storage type.
+
+       <tag>cache_dns_program</tag>
+       <p>DNS external helper interface has been removed. It was no longer
+          able to provide high performance service and the internal DNS
+          client library with multicast DNS cover all modern use-cases.
+
+       <tag>dns_children</tag>
+       <p>DNS external helper interface has been removed.
+
+</descrip>
+
+
+<sect>Changes to ./configure options since Squid-3.4
+<p>
+There have been some changes to Squid's build configuration since Squid-3.4.
+
+This section gives an account of those changes in three categories:
+
+<itemize>
+       <item><ref id="newoptions" name="New options">
+       <item><ref id="modifiedoptions" name="Changes to existing options">
+       <item><ref id="removedoptions" name="Removed options">
+</itemize>
+
+
+<sect1>New options<label id="newoptions">
+<p>
+<descrip>
+       <p><em>There are no new ./configure options in Squid-3.5.</em>
+
+</descrip>
+
+<sect1>Changes to existing options<label id="modifiedoptions">
+<p>
+<descrip>
+       <p><em>There are no changes to existing ./configure options in Squid-3.5.</em>
+
+</descrip>
+</p>
+
+<sect1>Removed options<label id="removedoptions">
+<p>
+<descrip>
+       <p><em>There are no removed ./configure options in Squid-3.5.</em>
+
+       <tag>--disable-internal-dns</tag>
+       <p>DNS external helper interface has been removed. It was no longer
+          able to provide high performance service and the internal DNS
+          client library with multicast DNS cover all modern use-cases.
+
+</descrip>
+
+
+<sect>Regressions since Squid-2.7
+
+<p>Some squid.conf options which were available in Squid-2.7 are not yet available in Squid-3.5
+
+<p>If you need something to do then porting one of these from Squid-2 to Squid-3 is most welcome.
+
+<sect1>Missing squid.conf options available in Squid-2.7
+<p>
+<descrip>
+       <tag>broken_vary_encoding</tag>
+       <p>Not yet ported from 2.6
+
+       <tag>cache_peer</tag>
+       <p><em>idle=</em> not yet ported from 2.7
+       <p><em>monitorinterval=</em> not yet ported from 2.6
+       <p><em>monitorsize=</em> not yet ported from 2.6
+       <p><em>monitortimeout=</em> not yet ported from 2.6
+       <p><em>monitorurl=</em> not yet ported from 2.6
+
+       <tag>cache_vary</tag>
+       <p>Not yet ported from 2.6
+
+       <tag>collapsed_forwarding</tag>
+       <p>Not yet ported from 2.6
+
+       <tag>error_map</tag>
+       <p>Not yet ported from 2.6
+
+       <tag>external_refresh_check</tag>
+       <p>Not yet ported from 2.7
+
+       <tag>location_rewrite_access</tag>
+       <p>Not yet ported from 2.6
+
+       <tag>location_rewrite_children</tag>
+       <p>Not yet ported from 2.6
+
+       <tag>location_rewrite_concurrency</tag>
+       <p>Not yet ported from 2.6
+
+       <tag>location_rewrite_program</tag>
+       <p>Not yet ported from 2.6
+
+       <tag>refresh_pattern</tag>
+       <p><em>stale-while-revalidate=</em> not yet ported from 2.7
+       <p><em>ignore-stale-while-revalidate=</em> not yet ported from 2.7
+       <p><em>negative-ttl=</em> not yet ported from 2.7
+
+       <tag>refresh_stale_hit</tag>
+       <p>Not yet ported from 2.7
+
+       <tag>update_headers</tag>
+       <p>Not yet ported from 2.7
+
+</descrip>
+
+</article>