doc/source/changelog.sgml

   1 <!--
   2  File        :  $Source: /cvsroot/ijbswa/current/doc/source/changelog.sgml,v $
   3
   4  Purpose     :  Entity included in other project documents.
   5
   6  $Id: changelog.sgml,v 2.22 2016/08/26 12:31:25 fabiankeil Exp $
   7
   8  Copyright (C) 2013-2016 Privoxy Developers https://www.privoxy.org/
   9  See LICENSE.
  10
  11  ======================================================================
  12   This file used for inclusion with other documents only.
  13  ======================================================================
  14
  15  If you make changes to this file, please verify the finished
  16  docs all display as intended.
  17
  18  This file is included into:
  19
  20   user-manual
  21 -->
  22
  23
  24 <!--
  25  The SGML ChangeLog can be generated with: utils/changelog2doc.pl ChangeLog
  26 -->
  27
  28 <para>
  29   <application>Privoxy 3.0.26</application> stable is a bug-fix release
  30   for the previously released 3.0.25 beta which introduced client-specific
  31   tags and included a couple of minor improvements.
  32 </para>
  33 <para>
  34  <itemizedlist>
  35   <listitem>
  36    <para>
  37     Bug fixes:
  38     <itemizedlist>
  39     <listitem>
  40      <para>
  41       Fixed crashes with "listen-addr :8118" (SF Bug #902).
  42       The regression was introduced in 3.0.25 beta and reported
  43       by Marvin Renich in Debian bug #834941.
  44     </para>
  45     </listitem>
  46     </itemizedlist>
  47    </para>
  48   </listitem>
  49   <listitem>
  50    <para>
  51     General improvements:
  52     <itemizedlist>
  53     <listitem>
  54      <para>
  55       Log when privoxy is toggled on or off via cgi interface.
  56      </para>
  57     </listitem>
  58     <listitem>
  59      <para>
  60       Highlight the "Info: Now toggled " on/off log message
  61       in the Windows log viewer.
  62      </para>
  63     </listitem>
  64     <listitem>
  65      <para>
  66       Highlight the loading actions/filter file log message
  67       in the Windows log viewer.
  68      </para>
  69     </listitem>
  70     <listitem>
  71      <para>
  72       Mention client-specific tags on the toggle page as a
  73       potentionally more appropriate alternative.
  74      </para>
  75      </listitem>
  76     </itemizedlist>
  77    </para>
  78   </listitem>
  79   <listitem>
  80    <para>
  81     Documentation improvements:
  82     <itemizedlist>
  83     <listitem>
  84      <para>
  85       Update download section on the homepage.
  86       The downloads are available from the website now.
  87      </para>
  88     </listitem>
  89     <listitem>
  90      <para>
  91       Add sponsor FAQ.
  92      </para>
  93     </listitem>
  94     <listitem>
  95      <para>
  96       Remove obsolete reference to mailing lists hosted at SourceForge.
  97      </para>
  98     </listitem>
  99     <listitem>
 100      <para>
 101       Update the "Before the Release" section of the developer manual.
 102      </para>
 103      </listitem>
 104     </itemizedlist>
 105    </para>
 106   </listitem>
 107   <listitem>
 108    <para>
 109     Infrastructure improvements:
 110     <itemizedlist>
 111     <listitem>
 112      <para>
 113       Add perl script to generate an RSS feed for the packages
 114       Submitted by "Unknown".
 115      </para>
 116      </listitem>
 117     </itemizedlist>
 118    </para>
 119   </listitem>
 120   <listitem>
 121    <para>
 122     Build system improvements:
 123     <itemizedlist>
 124     <listitem>
 125      <para>
 126       strptime.h: fix a compiler warning about ambiguous else.
 127      </para>
 128     </listitem>
 129     <listitem>
 130      <para>
 131       configure.in: Check for Docbook goo on the BSDs as well.
 132      </para>
 133     </listitem>
 134     <listitem>
 135      <para>
 136       GNUMakefile.in: Let the dok-user target remove temporary files.
 137      </para>
 138      </listitem>
 139     </itemizedlist>
 140    </para>
 141   </listitem>
 142  </itemizedlist>
 143 </para>
 144
 145 <para>
 146  Changes between <application>Privoxy 3.0.25 beta</application>
 147  and the previous release:
 148 </para>
 149 <para>
 150  <itemizedlist>
 151   <listitem>
 152    <para>
 153     Bug fixes:
 154     <itemizedlist>
 155     <listitem>
 156      <para>
 157       Always use the current toggle state for new requests.
 158       Previously new requests on reused connections inherited
 159       the toggle state from the previous request even though
 160       the toggle state could have changed.
 161       Reported by Robert Klemme.
 162      </para>
 163     </listitem>
 164     <listitem>
 165      <para>
 166       Fixed two buffer-overflows in the (deprecated) static
 167       pcre code. These bugs are not considered security issues
 168       as the input is trusted.
 169       Found with afl-fuzz and ASAN.
 170      </para>
 171      </listitem>
 172     </itemizedlist>
 173    </para>
 174   </listitem>
 175   <listitem>
 176    <para>
 177     General improvements:
 178     <itemizedlist>
 179     <listitem>
 180      <para>
 181       Added support for client-specific tags which allow Privoxy
 182       admins to pre-define tags that are set for all requests from
 183       clients that previously opted in through the CGI interface.
 184       They are useful in multi-user setups where admins may
 185       want to allow users to disable certain actions and filters
 186       for themselves without affecting others.
 187       In single-user setups they are useful to allow more fine-grained
 188       toggling. For example to disable request blocking while still
 189       crunching cookies, or to disable experimental filters only.
 190       This is an experimental feature, the syntax and behaviour may
 191       change in future versions.
 192       Sponsored by Robert Klemme.
 193      </para>
 194     </listitem>
 195     <listitem>
 196      <para>
 197       Dynamic filters and taggers now support a $listen-address variable
 198       which contains the address the request came in on.
 199       For external filters the variable is called $PRIVOXY_LISTEN_ADDRESS.
 200       Original patch contributed by pursievro.
 201      </para>
 202     </listitem>
 203     <listitem>
 204      <para>
 205       Add client-header-tagger 'listen-address'.
 206      </para>
 207     </listitem>
 208     <listitem>
 209      <para>
 210       Include the listen-address in the log message when logging new requests.
 211       Patch contributed by pursievro.
 212      </para>
 213     </listitem>
 214     <listitem>
 215      <para>
 216       Turn invalid max-client-connections values into fatal errors.
 217      </para>
 218     </listitem>
 219     <listitem>
 220      <para>
 221       The show-status page now shows whether or not dates before 1970
 222       and after 2038 are expected to be handled properly.
 223       This is mainly useful for Privoxy-Regression-Test but could
 224       also come handy when dealing with time-related support requests.
 225      </para>
 226     </listitem>
 227     <listitem>
 228      <para>
 229       On Mac OS X the thread id in log messages are more likely to
 230       be unique now.
 231      </para>
 232     </listitem>
 233     <listitem>
 234      <para>
 235       When complaining about missing filters, the filter type is logged
 236       as well.
 237      </para>
 238     </listitem>
 239     <listitem>
 240      <para>
 241       A couple of harmless coverity warnings were silenced
 242       (CID #161202, CID #161203, CID #161211).
 243      </para>
 244      </listitem>
 245     </itemizedlist>
 246    </para>
 247   </listitem>
 248   <listitem>
 249    <para>
 250     Action file improvements:
 251     <itemizedlist>
 252     <listitem>
 253      <para>
 254       Filtering is disabled for Range requests to let download resumption
 255       and Windows updates work with the default configuration.
 256      </para>
 257     </listitem>
 258     <listitem>
 259      <para>
 260       Unblock ".ardmediathek.de/".
 261       Reported by ThTomate in #932.
 262      </para>
 263      </listitem>
 264     </itemizedlist>
 265    </para>
 266   </listitem>
 267   <listitem>
 268    <para>
 269     Documentation improvements:
 270     <itemizedlist>
 271     <listitem>
 272      <para>
 273       Add FAQ entry for crashes caused by memory limits.
 274      </para>
 275     </listitem>
 276     <listitem>
 277      <para>
 278       Remove obsolete FAQ entry about a bug in PHP 4.2.3.
 279      </para>
 280     </listitem>
 281     <listitem>
 282      <para>
 283       Mention the new mailing lists were appropriate.
 284       As the archives have not been migrated, continue to
 285       mention the archives at SF in the contacting section
 286       for now.
 287      </para>
 288     </listitem>
 289     <listitem>
 290      <para>
 291       Note that the templates should be adjusted if Privoxy is
 292       running as intercepting proxy without getting all requests.
 293      </para>
 294     </listitem>
 295     <listitem>
 296      <para>
 297       A bunch of links were converted to https://.
 298      </para>
 299     </listitem>
 300     <listitem>
 301      <para>
 302       Rephrase onion service paragraph to make it more obvious
 303       that Tor is involved and that the whole website (and not
 304       just the homepage) is available as onion service.
 305      </para>
 306     </listitem>
 307     <listitem>
 308      <para>
 309       Streamline the "More information" section on the homepage further
 310       by additionally ditching the link to the 'See also' section
 311       of the user manual. The section contains mostly links that are
 312       directly reachable from the homepage already and the rest is
 313       not significant enough to get a link from the homepage.
 314      </para>
 315     </listitem>
 316     <listitem>
 317      <para>
 318       Change the add-header{} example to set the DNT header
 319       and use a complete section to make copy and pasting
 320       more convenient.
 321       Add a comment to make it obvious that adding the
 322       header is not recommended for obvious reasons.
 323       Using the DNT header as example was suggested by
 324       Leo Wzukw.
 325      </para>
 326     </listitem>
 327     <listitem>
 328      <para>
 329       Streamline the support-and-service template
 330       Instead of linking to the various support trackers
 331       (whose URLs hopefully change soon), link to the
 332       contact section of the user manual to increase the
 333       chances that users actually read it.
 334      </para>
 335     </listitem>
 336     <listitem>
 337      <para>
 338       Add a FAQ entry for tainted sockets.
 339      </para>
 340     </listitem>
 341     <listitem>
 342      <para>
 343       More sections in the documentation have stable URLs now.
 344      </para>
 345     </listitem>
 346     <listitem>
 347      <para>
 348       FAQ: Explain why 'ping config.privoxy.org' is not expected
 349       to reach a local Privoxy installation.
 350      </para>
 351     </listitem>
 352     <listitem>
 353      <para>
 354       Note that donations done through Zwiebelfreunde e.V. currently
 355       can't be checked automatically.
 356      </para>
 357     </listitem>
 358     <listitem>
 359      <para>
 360       Updated section regarding starting Privoxy under OS X.
 361      </para>
 362     </listitem>
 363     <listitem>
 364      <para>
 365       Use dedicated start instructions for FreeBSD and ElectroBSD.
 366      </para>
 367     </listitem>
 368     <listitem>
 369      <para>
 370       Removed release instructions for AIX. They haven't been working
 371       for years and unsurprisingly nobody seems to care.
 372      </para>
 373     </listitem>
 374     <listitem>
 375      <para>
 376       Removed obsolete reference to the solaris-dist target.
 377      </para>
 378     </listitem>
 379     <listitem>
 380      <para>
 381       Updated the release instructions for FreeBSD.
 382      </para>
 383     </listitem>
 384     <listitem>
 385      <para>
 386       Removed unfinished release instructions for Amiga OS and HP-UX 11.
 387      </para>
 388     </listitem>
 389     <listitem>
 390      <para>
 391       Added a pointer to the Cygwin Time Machine for getting the last release of
 392       Cygwin version 1.5 to use for building Privoxy on Windows.
 393      </para>
 394     </listitem>
 395     <listitem>
 396      <para>
 397       Various typos have been fixed.
 398      </para>
 399      </listitem>
 400     </itemizedlist>
 401    </para>
 402   </listitem>
 403   <listitem>
 404    <para>
 405     Infrastructure improvements:
 406     <itemizedlist>
 407     <listitem>
 408      <para>
 409       The website is no longer hosted at SourceForge and
 410       can be reached through https now.
 411      </para>
 412     </listitem>
 413     <listitem>
 414      <para>
 415       The mailing lists at SourceForge have been deprecated,
 416       you can subscribe to the new ones at: https://lists.privoxy.org/
 417      </para>
 418     </listitem>
 419     <listitem>
 420      <para>
 421       Migrating the remaining services from SourceForge is
 422       work in progress (TODO list item #53).
 423      </para>
 424      </listitem>
 425     </itemizedlist>
 426    </para>
 427   </listitem>
 428   <listitem>
 429    <para>
 430     Build system improvements:
 431     <itemizedlist>
 432     <listitem>
 433      <para>
 434       Add configure argument to optimistically redefine FD_SETSIZE
 435       with the intent to change the maximum number of client
 436       connections Privoxy can handle. Only works with some libcs.
 437       Sponsored by Robert Klemme.
 438      </para>
 439     </listitem>
 440     <listitem>
 441      <para>
 442       Let the tarball-dist target skip files in ".git".
 443      </para>
 444     </listitem>
 445     <listitem>
 446      <para>
 447       Let the tarball-dist target work in cwds other than current.
 448      </para>
 449     </listitem>
 450     <listitem>
 451      <para>
 452       Make the 'clean' target faster when run from a git repository.
 453      </para>
 454     </listitem>
 455     <listitem>
 456      <para>
 457       Include tools in the generic distribution.
 458      </para>
 459     </listitem>
 460     <listitem>
 461      <para>
 462       Let the gen-dist target work in cwds other than current.
 463      </para>
 464     </listitem>
 465     <listitem>
 466      <para>
 467       Sort find output that is used for distribution tarballs
 468       to get reproducible results.
 469      </para>
 470     </listitem>
 471     <listitem>
 472      <para>
 473       Don't add '-src' to the name of the tar ball generated by the
 474       gen-dist target. The package isn't a source distribution but a
 475       binary package.
 476       While at it, use a variable for the name to reduce the chances
 477       that the various references get out of sync and fix the gen-upload
 478       target which was looking in the wrong directory.
 479      </para>
 480     </listitem>
 481     <listitem>
 482      <para>
 483       Add regression-tests.action to the files that are distributed.
 484      </para>
 485     </listitem>
 486     <listitem>
 487      <para>
 488       The gen-dist target which was broken since 2002 (r1.92) has been fixed.
 489      </para>
 490     </listitem>
 491     <listitem>
 492      <para>
 493       Remove genclspec.sh which has been obsolete since 2009.
 494      </para>
 495     </listitem>
 496     <listitem>
 497      <para>
 498       Remove obsolete reference to Redhat spec file.
 499      </para>
 500     </listitem>
 501     <listitem>
 502      <para>
 503       Remove the obsolete announce target which has been commented out years ago.
 504      </para>
 505     </listitem>
 506     <listitem>
 507      <para>
 508       Let rsync skip files if the checksums match.
 509      </para>
 510      </listitem>
 511     </itemizedlist>
 512    </para>
 513   </listitem>
 514   <listitem>
 515    <para>
 516     Privoxy-Regression-Test:
 517     <itemizedlist>
 518     <listitem>
 519      <para>
 520       Add a "Default level offset" directive which can be used to
 521       change the default level by a given value.
 522       This directive affects all tests located after it until the end
 523       of the file or a another "Default level offset" directive is reached.
 524       The purpose of this directive is to make it more convenient to skip
 525       similar tests in a given file without having to remove or disable
 526       the tests completely.
 527      </para>
 528     </listitem>
 529     <listitem>
 530      <para>
 531       Let test level 17 depend on FEATURE_64_BIT_TIME_T
 532       instead of FEATURE_PTHREAD which has no direct connection
 533       to the time_t size.
 534      </para>
 535     </listitem>
 536     <listitem>
 537      <para>
 538       Fix indentation in perldoc examples.
 539      </para>
 540     </listitem>
 541     <listitem>
 542      <para>
 543       Don't overlook directives in the first line of the action file.
 544      </para>
 545     </listitem>
 546     <listitem>
 547      <para>
 548       Bump version to 0.7.
 549      </para>
 550     </listitem>
 551     <listitem>
 552      <para>
 553       Fix detection of the Privoxy version now that https://
 554       is used for the website.
 555      </para>
 556      </listitem>
 557     </itemizedlist>
 558    </para>
 559   </listitem>
 560  </itemizedlist>
 561 </para>