From 5ca5c84b58b9719281446d46e1a8cc9f0d1d72fd Mon Sep 17 00:00:00 2001
From: Fabian Keil <fk@fabiankeil.de>
Date: Sat, 19 Nov 2011 15:18:02 +0000
Subject: [PATCH] Update ChangeLog

---
 doc/source/user-manual.sgml | 303 +++++++++++++++++-------------------
 1 file changed, 145 insertions(+), 158 deletions(-)

diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 4f1653d9..fa03f4dd 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -34,7 +34,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
 
- $Id: user-manual.sgml,v 2.138 2011/11/13 17:03:54 fabiankeil Exp $
+ $Id: user-manual.sgml,v 2.139 2011/11/18 16:49:29 fabiankeil Exp $
 
  Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/
  See LICENSE.
@@ -60,7 +60,7 @@
  </subscript>
 </pubdate>
 
-<pubdate>$Id: user-manual.sgml,v 2.138 2011/11/13 17:03:54 fabiankeil Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 2.139 2011/11/18 16:49:29 fabiankeil Exp $</pubdate>
 
 <!--
 
@@ -486,6 +486,72 @@ How to install the binary packages depends on your operating system:
       valgrind while touching action files in a loop. It's unlikely
       to have caused any actual problems in the real world.
      </para>
+    </listitem>
+    <listitem>
+     <para>
+      Disable filters if SDCH compression is used unless filtering is forced.
+      If SDCH was combined with a supported compression algorithm, Privoxy
+      previously could try to decompress it and ditch the Content-Encoding
+      header even though the SDCH compression wasn't dealt with.
+      Reported by zebul666 in #3225863.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Make a copy of the --user value and only mess with that when splitting
+      user and group. On some operating systems modifying the value directly
+      is reflected in the output of ps and friends and can be misleading.
+      Reported by zepard in #3292710.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      If forwarded-connect-retries is set, only retry if Privoxy is actually
+      forwarding the request. Previously direct connections would be retried
+      as well.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Fixed a small memory leak when retrying connections with IPv6 support
+      enabled.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Remove an incorrect assertion in compile_dynamic_pcrs_job_list()
+      It could be triggered by a pcrs job with an invalid pcre
+      pattern (for example one that contains a lone quantifier).
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      If the --user argument user[.group] contains a dot, always bail out
+      if no group has been specified. Previously the intended, but undocumented
+      (and apparently untested), behaviour was to try interpreting the whole
+      argument as user name, but the detection was flawed and checked for '0'
+      instead of '\0', thus merely preventing group names beginning with a zero.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      In html_code_map[], use a numeric character reference instead of &apos;
+      which wasn't standardized before XHTML 1.0.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Fix an invalid free when compiled with FEATURE_GRACEFUL_TERMINATION
+      and shut down through http://config.privoxy.org/die
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      In get_actions(), fix the "temporary" backwards compatibility hack
+      to accept block actions without reason.
+      It also covered other actions that should be rejected as invalid.
+      Reported by Billy Crook.
+     </para>
      </listitem>
     </itemizedlist>
    </para>
@@ -527,22 +593,7 @@ How to install the binary packages depends on your operating system:
      <para>
       Set socket_error to errno if connecting fails in rfc2553_connect_to()
       Previously rejected direct connections could be incorrectly reported
-      as DNS issues.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Disable filters if SDCH compression is used unless filtering is forced.
-      If SDCH was combined with a supported compression algorithm,
-      we'd previously try to decompress it, when successful apply
-      the enabled filters and ditch the Content-Encoding header
-      even though the SDCH compression wasn't removed.
-      Reported by zebul666 in #3225863.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Properly deal with FEATURE_TOGGLE being disabled
+      as DNS issues if Privoxy was compiled with IPv6 support.
      </para>
     </listitem>
     <listitem>
@@ -550,7 +601,7 @@ How to install the binary packages depends on your operating system:
       Adjust url_code_map[] so spaces are replaced with %20 instead of '+'
       While '+' can be used by client's submitting form data, this is not
       actually what Privoxy is using the lookups for. This is more of a
-      cosmetic issue and doesn't fix any actual problems.
+      cosmetic issue and doesn't fix any known problems.
      </para>
     </listitem>
     <listitem>
@@ -586,33 +637,6 @@ How to install the binary packages depends on your operating system:
       (when grepping in multiple log files) without hassle.
      </para>
     </listitem>
-    <listitem>
-     <para>
-      Make a copy of the --user value and only mess with that when splitting
-      user and group. On some operating systems modifying the value directly
-      is reflected in the output of ps and friends and can be misleading.
-      Reported by zepard in #3292710.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      If forwarded-connect-retries is set, only retry if the we are actually
-      forwarding the request. Previously direct connections would be retried
-      as well.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Fixed a small memory leak when retrying connection
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Remove an incorrect assertion in compile_dynamic_pcrs_job_list()
-      It could be triggered by a pcrs job with an invalid pcre
-      pattern (for example one that contains a lone quantifier).
-     </para>
-    </listitem>
     <listitem>
      <para>
       In get_last_url(), do not bother trying to decode URLs that do
@@ -622,13 +646,7 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      If the --user argument user[.group] contains a dot,
-      always bail out if no group has been specified.
-      Previously the intended, but undocumented (and apparently
-      untested), behaviour was to try interpreting the whole
-      argument as user name, but the detection was flawed and
-      checked for '0' isntead of '\0', thus merely preventing
-      group names beginning with a zero.
+      In case of SOCKS5 failures, dump the socks response in the log message.
      </para>
     </listitem>
     <listitem>
@@ -641,57 +659,44 @@ How to install the binary packages depends on your operating system:
       Streamline socks5_connect() slightly
      </para>
     </listitem>
-    <listitem>
-     <para>
-      In case of SOCKS5 failures, dump the socks response
-     </para>
-    </listitem>
     <listitem>
      <para>
       In socks5_connect(), require a complete socks response from the server
-      Previously we didn't care how much data the server response
+      Previously Privoxy didn't care how much data the server response
       contained as long as the first two bytes contained the expected
-      values.
-      While at it, shrink the buffer size so we can't read more
-      than a whole socks response. This is required to support
-      Tor's optimistic data extension.
+      values. While at it, shrink the buffer size so Privoxy can't read
+      more than a whole socks response.
      </para>
     </listitem>
     <listitem>
      <para>
       In chat(), do not bother to generate a client request in case of
-      direct CONNECT requests
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Reduce server_last_modified()'s stack size
+      direct CONNECT requests. It will not be used anyway.
      </para>
     </listitem>
     <listitem>
      <para>
-      Shorten get_http_time() by using strftime()
+      Reduce server_last_modified()'s stack size.
      </para>
     </listitem>
     <listitem>
      <para>
-      Constify the known_http_methods pointers in unknown_method()
+      Shorten get_http_time() by using strftime().
      </para>
     </listitem>
     <listitem>
      <para>
-      Constify the time_formats pointers in parse_header_time()
+      Constify the known_http_methods pointers in unknown_method().
      </para>
     </listitem>
     <listitem>
      <para>
-      Constify the formerly_valid_actions pointers in action_used_to_be_valid()
+      Constify the time_formats pointers in parse_header_time().
      </para>
     </listitem>
     <listitem>
      <para>
-      In html_code_map[], use a numeric character reference instead of &apos;
-      which wasn't standardized before XHTML 1.0
+      Constify the formerly_valid_actions pointers in action_used_to_be_valid().
      </para>
     </listitem>
     <listitem>
@@ -714,7 +719,7 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      Remove a useless NULL pointer check in load_trustfile()
+      Remove a useless NULL pointer check in load_trustfile().
      </para>
     </listitem>
     <listitem>
@@ -725,14 +730,13 @@ How to install the binary packages depends on your operating system:
     <listitem>
      <para>
       Change url_code_map[] from an array of pointers to an array of arrays
-      It removes an unnecessary layer of indirection and on
-      64bit system reduces the size of the binary a bit.
+      It removes an unnecessary layer of indirection and on 64bit system reduces
+      the size of the binary a bit.
      </para>
     </listitem>
     <listitem>
      <para>
-      Fix various typos.
-      Fixes taken from Debian's 29_typos.dpatch by Roland Rosenfeld.
+      Fix various typos. Fixes taken from Debian's 29_typos.dpatch by Roland Rosenfeld.
      </para>
     </listitem>
     <listitem>
@@ -759,10 +763,9 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      Add a dedicated function to parse the values of toggles
-      Reduces duplicated code in load_config() and provides
-      better error handling. Invalid or missing toggle values
-      are now a fatal error instead of being silently ignored.
+      Add a dedicated function to parse the values of toggles. Reduces duplicated
+      code in load_config() and provides better error handling. Invalid or missing
+      toggle values are now a fatal error instead of being silently ignored.
      </para>
     </listitem>
     <listitem>
@@ -778,7 +781,7 @@ How to install the binary packages depends on your operating system:
     <listitem>
      <para>
       In LogPutString(), don't bother looking at pszText when not
-      actually logging anything
+      actually logging anything.
      </para>
     </listitem>
     <listitem>
@@ -818,12 +821,6 @@ How to install the binary packages depends on your operating system:
       Add a proper CGI message for cgi_die().
      </para>
     </listitem>
-    <listitem>
-     <para>
-      Fix an invalid free when compiled with FEATURE_GRACEFUL_TERMINATION
-      and shut down through http://config.privoxy.org/die
-     </para>
-    </listitem>
     <listitem>
      <para>
       Don't enforce a logical line length limit in read_config_line()
@@ -847,17 +844,9 @@ How to install the binary packages depends on your operating system:
     <listitem>
      <para>
       In block_url(), consistently use the block reason "Request blocked by Privoxy"
-      In two places the reason was "Request for blocked URL" which
-      hides the fact that the request got blocked by Privoxy and
-      isn't necessarly correct as the block may be due to tags.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      In get_actions(), fix the "temporary" backwards compatibility hack
-      to accept block actions without reason.
-      It also covered other actions that should be rejected as invalid.
-      Reported by Billy Crook.
+      In two places the reason was "Request for blocked URL" which hides the
+      fact that the request got blocked by Privoxy and isn't necessarily
+      correct as the block may be due to tags.
      </para>
     </listitem>
     <listitem>
@@ -878,16 +867,16 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      The socket timeout is used for SOCKS negotiation as well.
+      The socket timeout is used for SOCKS negotiations as well which
+      previously couldn't timeout.
      </para>
     </listitem>
     <listitem>
      <para>
       Don't keep the client connection alive if any configuration file
-      changed since the time the connection came in.
-      This is closer to Privoxy's behaviour before keep-alive support
-      for client connection has been added and also less confusing in
-      general.
+      changed since the time the connection came in. This is closer to
+      Privoxy's behaviour before keep-alive support for client connection
+      has been added and also less confusing in general.
      </para>
     </listitem>
     <listitem>
@@ -913,9 +902,8 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      Remove -prevent-compression from the fragile alias
-      It's no longer used anywhere by default and isn't
-      known to break stuff anyway.
+      Remove -prevent-compression from the fragile alias It's no longer
+      used anywhere by default and isn't known to break stuff anyway.
      </para>
     </listitem>
     <listitem>
@@ -1024,13 +1012,9 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      Let the msn filter hide overlay ads for Facebook 'likes' in search results.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Let the msn filter hide elements with the id 's_notf_div'.
-      They only seem to be used to advertise site 'enhancements'.
+      Let the msn filter hide overlay ads for Facebook 'likes' in search
+      results and elements with the id 's_notf_div'. They only seem to be
+      used to advertise site 'enhancements'.
      </para>
     </listitem>
     <listitem>
@@ -1054,23 +1038,21 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      Point out that the SourceForge messaging system works
-      like a blackhole and should thus not be used to contact
-      individual developers.
+      Point out that the SourceForge messaging system works like a black
+      hole and should thus not be used to contact individual developers.
      </para>
     </listitem>
     <listitem>
      <para>
-      Mention some of the problems one can experience when not
-      explicitly configuring an IP addresses as listen address.
+      Mention some of the problems one can experience when not explicitly
+      configuring an IP addresses as listen address.
      </para>
     </listitem>
     <listitem>
      <para>
-      Explicitly mention that hostnames can be used instead of
-      IP addresses for the listen-address, that only the first
-      address returned will be used and what happens if the
-      address is invalid.
+      Explicitly mention that hostnames can be used instead of IP addresses
+      for the listen-address, that only the first address returned will be
+      used and what happens if the address is invalid.
       Requested by Calestyo in #3302213.
      </para>
      </listitem>
@@ -1118,7 +1100,7 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      Do not claim to listen on a socket until we actually do.
+      Do not claim to listen on a socket until Privoxy actually does.
       Patch submitted by Petr Pisar #3354485
      </para>
     </listitem>
@@ -1160,7 +1142,7 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      In rfc2553_connect_to(), explain getnameinfo() errors differently.
+      In rfc2553_connect_to(), explain getnameinfo() errors better.
      </para>
     </listitem>
     <listitem>
@@ -1176,25 +1158,24 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      Rephrase a log message in compile_dynamic_pcrs_job_list()
-      Divide the error code and its meaning with a colon.
-      Call the pcrs job dynamic and not the filter. Filters may
-      contain dynamic and non-dynamic pcrs jobs at the same time.
-      Only mention the name of the filter or tagger, but don't
-      claim it's a filter when it could be a tagger.
+      Rephrase a log message in compile_dynamic_pcrs_job_list().
+      Divide the error code and its meaning with a colon. Call the pcrs
+      job dynamic and not the filter. Filters may contain dynamic and
+      non-dynamic pcrs jobs at the same time. Only mention the name of
+      the filter or tagger, but don't claim it's a filter when it could
+      be a tagger.
      </para>
     </listitem>
     <listitem>
      <para>
       In a fatal error message in load_one_actions_file(), cover both
-      URL and TAG patterns
+      URL and TAG patterns.
      </para>
     </listitem>
     <listitem>
      <para>
       In pcrs_strerror(), properly report unknown positive error code
-      values as unknown.
-      Previously they were handled like 0 (no error).
+      values as such. Previously they were handled like 0 (no error).
      </para>
     </listitem>
     <listitem>
@@ -1227,8 +1208,8 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      In connection_destination_matches(), improve two log messages to
-      help understand why the destinations don't match
+      In connection_destination_matches(), improve two log messages
+      to help understand why the destinations don't match.
      </para>
     </listitem>
     <listitem>
@@ -1246,9 +1227,8 @@ How to install the binary packages depends on your operating system:
     <listitem>
      <para>
       Let mark_server_socket_tainted() always mark the server socket tainted,
-      just don't talk about it in cases where it has no effect.
-      It doesn't change Privoxy's behaviour, but makes understanding
-      the log file easier.
+      just don't talk about it in cases where it has no effect. It doesn't change
+      Privoxy's behaviour, but makes understanding the log file easier.
      </para>
      </listitem>
     </itemizedlist>
@@ -1271,22 +1251,22 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      Remove a useless test for setpgrp(2). Privoxy doesn't
-      need it and it can cause problems when cross-compiling
+      Remove a useless test for setpgrp(2). Privoxy doesn't need it and
+      it can cause problems when cross-compiling.
      </para>
     </listitem>
     <listitem>
      <para>
-      Rename the --disable-acl-files switch to --disable-acl-support
-      Since about 2001, ACL directives are specified in the standard config file.
+      Rename the --disable-acl-files switch to --disable-acl-support.
+      Since about 2001, ACL directives are specified in the standard
+      config file.
      </para>
     </listitem>
     <listitem>
      <para>
       Update the URL of the 'Removing outdated PCRE version after the
-      next stable release' posting.
-      The old URL stopped working after one of SF's recent layout pessimizations.
-      Reported by Han Liu.
+      next stable release' posting. The old URL stopped working after
+      one of SF's recent site "optimizations". Reported by Han Liu.
      </para>
      </listitem>
     </itemizedlist>
@@ -1298,7 +1278,7 @@ How to install the binary packages depends on your operating system:
     <itemizedlist>
     <listitem>
      <para>
-      Added --shuffle-tests option to increase the chances of detection race conditions
+      Added --shuffle-tests option to increase the chances of detection race conditions.
      </para>
     </listitem>
     <listitem>
@@ -1313,14 +1293,12 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      The --privoxy-address option now works with IPv6 addresses
-      containing brackets, too
+      The --privoxy-address option now works with IPv6 addresses containing brackets, too
      </para>
     </listitem>
     <listitem>
      <para>
-      Perform limited sanity checks for parameters that are supposed
-      to have numerical values.
+      Perform limited sanity checks for parameters that are supposed to have numerical values.
      </para>
     </listitem>
     <listitem>
@@ -1348,6 +1326,11 @@ How to install the binary packages depends on your operating system:
      <para>
       In the --help output, include a list of supported tests and their default levels.
      </para>
+    </listitem>
+    <listitem>
+     <para>
+      Adjust the tests to properly deal with FEATURE_TOGGLE being disabled.
+     </para>
      </listitem>
     </itemizedlist>
    </para>
@@ -1358,8 +1341,8 @@ How to install the binary packages depends on your operating system:
     <itemizedlist>
     <listitem>
      <para>
-      Perform limited sanity checks for parameters that are supposed
-      to have numerical values.
+      Perform limited sanity checks for command line parameters that
+      are supposed to have numerical values.
      </para>
     </listitem>
     <listitem>
@@ -1406,8 +1389,9 @@ How to install the binary packages depends on your operating system:
     </listitem>
     <listitem>
      <para>
-      Only randomize the release date if the new --randomize-release-date option is enabled.
-      Firefox versions after 4 use a fixed date string without meaning.
+      Only randomize the release date if the new --randomize-release-date
+      option is enabled. Firefox versions after 4 use a fixed date string
+      without meaning.
      </para>
      </listitem>
     </itemizedlist>
@@ -9378,6 +9362,9 @@ In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibut
  USA
 
  $Log: user-manual.sgml,v $
+ Revision 2.139  2011/11/18 16:49:29  fabiankeil
+ Update ChangeLog
+
  Revision 2.138  2011/11/13 17:03:54  fabiankeil
  Bump entities for 3.0.18 stable
 
-- 
2.39.2