From: Amos Jeffries <amosjeffries@squid-cache.org>
Date: Fri, 29 Oct 2010 03:26:33 +0000 (-0600)
Subject: Move client delay pools release notes to 3.2
X-Git-Tag: take1~126
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=69a9b4decdb1289c37b49654c709c89f5ef6ccdc;p=thirdparty%2Fsquid.git

Move client delay pools release notes to 3.2
---

diff --git a/doc/release-notes/release-3.2.sgml b/doc/release-notes/release-3.2.sgml
index 5e4b60f0c0..84de311ca8 100644
--- a/doc/release-notes/release-3.2.sgml
+++ b/doc/release-notes/release-3.2.sgml
@@ -41,6 +41,7 @@ The 3.2 change history can be <url url="http://www.squid-cache.org/Versions/v3/3
 	<item>Solaris 10 pthreads Support (Experimental)
 	<item>Surrogate/1.0 protocol extensions to HTTP
 	<item>Logging Infrastructure Updated
+	<item>Client Bandwidth Limits
 </itemize>
 
 Most user-facing changes are reflected in squid.conf (see below).
@@ -286,6 +287,36 @@ Most user-facing changes are reflected in squid.conf (see below).
   required to store a long period of access.log and needs to conserve disk space.
 
 
+<sect1> Client Bandwidth Limits
+<p>In mobile environments, Squid may need to limit Squid-to-client bandwidth
+   available to individual users, identified by their IP addresses. The IP
+   address pool can be as large as a /10 IPv4 network (4 million unique IP
+   addresses) and even larger in IPv6 environments. On the other hand, the code
+   should support thousands of connections coming from a single IP (e.g.,
+   a child proxy).
+
+<p>The implementation is based on storing bandwidth-related "bucket" information
+   in the existing "client database" hash (client_db.cc). The old code already
+   assigned each client IP a single ClientInfo object, which satisfies the
+   client-side IP-based bandwidth pooling requirements. The old hash size is
+   increased to support up to 32K concurrent clients if needed.
+
+<p>Client-side pools are configured similarly to server-side ones, but there is
+   only one pool class. See client_delay_pools,
+   client_delay_initial_bucket_level, client_delay_parameters, and
+   client_delay_access in squid.conf. The client_delay_access matches the client
+   with delay parameters. It does not pool clients from different IP addresses
+   together.
+
+<p>Special care is taken to provide fair distribution of bandwidth among clients
+   sharing the same bucket (i.e., clients coming from the same IP address).
+   Multiple same-IP clients competing for bandwidth are queued using FIFO
+   algorithm. If a bucket becomes empty, the first client among those sharing 
+   the bucket is delayed by 1 second before it can attempt to receive more
+   response data from Squid.  This delay may need to be lowered in 
+   high-bandwidth environments.
+
+
 <sect>Changes to squid.conf since Squid-3.1
 <p>
 There have been changes to Squid's configuration file since Squid-3.1.
@@ -302,6 +333,23 @@ This section gives a thorough account of those changes in three categories:
 <sect1>New tags<label id="newtags">
 <p>
 <descrip>
+	<tag>client_delay_pools</tag>
+	<p>New setting for client bandwith limits to specifies the number 
+	  of client delay pools used.
+
+	<tag>client_delay_initial_bucket_level</tag>
+	<p>New setting for client bandwith limits to determine the initial 
+	  bucket size as a percentage of  max_bucket_size from 
+	  client_delay_parameters.
+            
+	<tag>client_delay_parameters</tag>
+	<p>New setting for client bandwith limits to configures client-side 
+	   bandwidth limits.
+
+	<tag>client_delay_access</tag>
+	<p>New setting for client bandwith limits to determines the 
+	  client-side delay pool for the request.
+
 	<tag>cpu_affinity_map</tag>
 	<p>New setting for SMP support to map Squid processes onto specific CPU cores.
 
diff --git a/doc/release-notes/release-3.3.sgml b/doc/release-notes/release-3.3.sgml
index 6e2c26914d..f2d8da2356 100644
--- a/doc/release-notes/release-3.3.sgml
+++ b/doc/release-notes/release-3.3.sgml
@@ -34,40 +34,12 @@ The 3.3 change history can be <url url="http://www.squid-cache.org/Versions/v3/3
 
 <p>The most important of these new features are:
 <itemize>
-	<item>Client Bandwidth Limits
+	<item>
 </itemize>
 
 Most user-facing changes are reflected in squid.conf (see below).
 
-<sect1> Client Bandwidth Limits
-<p>In mobile environments, Squid may need to limit Squid-to-client bandwidth
-   available to individual users, identified by their IP addresses. The IP
-   address pool can be as large as a /10 IPv4 network (4 million unique IP
-   addresses) and even larger in IPv6 environments. On the other hand, the code
-   should support thousands of connections coming from a single IP (e.g.,
-   a child proxy).
-
-<p>The implementation is based on storing bandwidth-related "bucket" information
-   in the existing "client database" hash (client_db.cc). The old code already
-   assigned each client IP a single ClientInfo object, which satisfies the
-   client-side IP-based bandwidth pooling requirements. The old hash size is
-   increased to support up to 32K concurrent clients if needed.
-
-<p>Client-side pools are configured similarly to server-side ones, but there is
-   only one pool class. See client_delay_pools,
-   client_delay_initial_bucket_level, client_delay_parameters, and
-   client_delay_access in squid.conf. The client_delay_access matches the client
-   with delay parameters. It does not pool clients from different IP addresses
-   together.
-
-<p>
-   Special care is taken to provide fair distribution of bandwidth among clients
-   sharing the same bucket (i.e., clients coming from the same IP address).
-   Multiple same-IP clients competing for bandwidth are queued using FIFO
-   algorithm. If a bucket becomes empty, the first client among those sharing 
-   the bucket is delayed by 1 second before it can attempt to receive more
-   response data from Squid.  This delay may need to be lowered in 
-   high-bandwidth environments.
+<sect1>
 
 <sect>Changes to squid.conf since Squid-3.2
 <p>
@@ -85,22 +57,6 @@ This section gives a thorough account of those changes in three categories:
 <sect1>New tags<label id="newtags">
 <p>
 <descrip>
-            <tag>client_delay_pools</tag>
-            <p> New setting for client bandwith limits to specifies the number 
-              of client delay pools used.
-
-            <tag>client_delay_initial_bucket_level</tag>
-            <p> New setting for client bandwith limits to determine the initial 
-              bucket size as a percentage of  max_bucket_size from 
-              client_delay_parameters.
-
-            <tag>client_delay_parameters</tag>
-            <p> New setting for client bandwith limits to configures client-side 
-              bandwidth limits.
-
-            <tag>client_delay_access</tag>
-            <p> New setting for client bandwith limits to determines the 
-              client-side delay pool for the request.
 </descrip>
 
 <sect1>Changes to existing tags<label id="modifiedtags">