Update the SGML version of the ChangeLog
[privoxy.git] / 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.21 2016/08/26 03:21:04 ler762 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
146
147 <para>
148   <application>Privoxy 3.0.25</application> beta introduces client-specific
149   tags and includes a couple of minor improvements. It will be followed
150   by a stable release in the near future.
151 </para>
152 <para>
153  <itemizedlist>
154   <listitem>
155    <para>
156     Bug fixes:
157     <itemizedlist>
158     <listitem>
159      <para>
160       Always use the current toggle state for new requests.
161       Previously new requests on reused connections inherited
162       the toggle state from the previous request even though
163       the toggle state could have changed.
164       Reported by Robert Klemme.
165      </para>
166     </listitem>
167     <listitem>
168      <para>
169       Fixed two buffer-overflows in the (deprecated) static
170       pcre code. These bugs are not considered security issues
171       as the input is trusted.
172       Found with afl-fuzz and ASAN.
173      </para>
174      </listitem>
175     </itemizedlist>
176    </para>
177   </listitem>
178   <listitem>
179    <para>
180     General improvements:
181     <itemizedlist>
182     <listitem>
183      <para>
184       Added support for client-specific tags which allow Privoxy
185       admins to pre-define tags that are set for all requests from
186       clients that previously opted in through the CGI interface.
187       They are useful in multi-user setups where admins may
188       want to allow users to disable certain actions and filters
189       for themselves without affecting others.
190       In single-user setups they are useful to allow more fine-grained
191       toggling. For example to disable request blocking while still
192       crunching cookies, or to disable experimental filters only.
193       This is an experimental feature, the syntax and behaviour may
194       change in future versions.
195       Sponsored by Robert Klemme.
196      </para>
197     </listitem>
198     <listitem>
199      <para>
200       Dynamic filters and taggers now support a $listen-address variable
201       which contains the address the request came in on.
202       For external filters the variable is called $PRIVOXY_LISTEN_ADDRESS.
203       Original patch contributed by pursievro.
204      </para>
205     </listitem>
206     <listitem>
207      <para>
208       Add client-header-tagger 'listen-address'.
209      </para>
210     </listitem>
211     <listitem>
212      <para>
213       Include the listen-address in the log message when logging new requests.
214       Patch contributed by pursievro.
215      </para>
216     </listitem>
217     <listitem>
218      <para>
219       Turn invalid max-client-connections values into fatal errors.
220      </para>
221     </listitem>
222     <listitem>
223      <para>
224       The show-status page now shows whether or not dates before 1970
225       and after 2038 are expected to be handled properly.
226       This is mainly useful for Privoxy-Regression-Test but could
227       also come handy when dealing with time-related support requests.
228      </para>
229     </listitem>
230     <listitem>
231      <para>
232       On Mac OS X the thread id in log messages are more likely to
233       be unique now.
234      </para>
235     </listitem>
236     <listitem>
237      <para>
238       When complaining about missing filters, the filter type is logged
239       as well.
240      </para>
241     </listitem>
242     <listitem>
243      <para>
244       A couple of harmless coverity warnings were silenced
245       (CID #161202, CID #161203, CID #161211).
246      </para>
247      </listitem>
248     </itemizedlist>
249    </para>
250   </listitem>
251   <listitem>
252    <para>
253     Action file improvements:
254     <itemizedlist>
255     <listitem>
256      <para>
257       Filtering is disabled for Range requests to let download resumption
258       and Windows updates work with the default configuration.
259      </para>
260     </listitem>
261     <listitem>
262      <para>
263       Unblock ".ardmediathek.de/".
264       Reported by ThTomate in #932.
265      </para>
266      </listitem>
267     </itemizedlist>
268    </para>
269   </listitem>
270   <listitem>
271    <para>
272     Documentation improvements:
273     <itemizedlist>
274     <listitem>
275      <para>
276       Add FAQ entry for crashes caused by memory limits.
277      </para>
278     </listitem>
279     <listitem>
280      <para>
281       Remove obsolete FAQ entry about a bug in PHP 4.2.3.
282      </para>
283     </listitem>
284     <listitem>
285      <para>
286       Mention the new mailing lists were appropriate.
287       As the archives have not been migrated, continue to
288       mention the archives at SF in the contacting section
289       for now.
290      </para>
291     </listitem>
292     <listitem>
293      <para>
294       Note that the templates should be adjusted if Privoxy is
295       running as intercepting proxy without getting all requests.
296      </para>
297     </listitem>
298     <listitem>
299      <para>
300       A bunch of links were converted to https://.
301      </para>
302     </listitem>
303     <listitem>
304      <para>
305       Rephrase onion service paragraph to make it more obvious
306       that Tor is involved and that the whole website (and not
307       just the homepage) is available as onion service.
308      </para>
309     </listitem>
310     <listitem>
311      <para>
312       Streamline the "More information" section on the homepage further
313       by additionally ditching the link to the 'See also' section
314       of the user manual. The section contains mostly links that are
315       directly reachable from the homepage already and the rest is
316       not significant enough to get a link from the homepage.
317      </para>
318     </listitem>
319     <listitem>
320      <para>
321       Change the add-header{} example to set the DNT header
322       and use a complete section to make copy and pasting
323       more convenient.
324       Add a comment to make it obvious that adding the
325       header is not recommended for obvious reasons.
326       Using the DNT header as example was suggested by
327       Leo Wzukw.
328      </para>
329     </listitem>
330     <listitem>
331      <para>
332       Streamline the support-and-service template
333       Instead of linking to the various support trackers
334       (whose URLs hopefully change soon), link to the
335       contact section of the user manual to increase the
336       chances that users actually read it.
337      </para>
338     </listitem>
339     <listitem>
340      <para>
341       Add a FAQ entry for tainted sockets.
342      </para>
343     </listitem>
344     <listitem>
345      <para>
346       More sections in the documentation have stable URLs now.
347      </para>
348     </listitem>
349     <listitem>
350      <para>
351       FAQ: Explain why 'ping config.privoxy.org' is not expected
352       to reach a local Privoxy installation.
353      </para>
354     </listitem>
355     <listitem>
356      <para>
357       Note that donations done through Zwiebelfreunde e.V. currently
358       can't be checked automatically.
359      </para>
360     </listitem>
361     <listitem>
362      <para>
363       Updated section regarding starting Privoxy under OS X.
364      </para>
365     </listitem>
366     <listitem>
367      <para>
368       Use dedicated start instructions for FreeBSD and ElectroBSD.
369      </para>
370     </listitem>
371     <listitem>
372      <para>
373       Removed release instructions for AIX. They haven't been working
374       for years and unsurprisingly nobody seems to care.
375      </para>
376     </listitem>
377     <listitem>
378      <para>
379       Removed obsolete reference to the solaris-dist target.
380      </para>
381     </listitem>
382     <listitem>
383      <para>
384       Updated the release instructions for FreeBSD.
385      </para>
386     </listitem>
387     <listitem>
388      <para>
389       Removed unfinished release instructions for Amiga OS and HP-UX 11.
390      </para>
391     </listitem>
392     <listitem>
393      <para>
394       Added a pointer to the Cygwin Time Machine for getting the last release of
395       Cygwin version 1.5 to use for building Privoxy on Windows.
396      </para>
397     </listitem>
398     <listitem>
399      <para>
400       Various typos have been fixed.
401      </para>
402      </listitem>
403     </itemizedlist>
404    </para>
405   </listitem>
406   <listitem>
407    <para>
408     Infrastructure improvements:
409     <itemizedlist>
410     <listitem>
411      <para>
412       The website is no longer hosted at SourceForge and
413       can be reached through https now.
414      </para>
415     </listitem>
416     <listitem>
417      <para>
418       The mailing lists at SourceForge have been deprecated,
419       you can subscribe to the new ones at: https://lists.privoxy.org/
420      </para>
421     </listitem>
422     <listitem>
423      <para>
424       Migrating the remaining services from SourceForge is
425       work in progress (TODO list item #53).
426      </para>
427      </listitem>
428     </itemizedlist>
429    </para>
430   </listitem>
431   <listitem>
432    <para>
433     Build system improvements:
434     <itemizedlist>
435     <listitem>
436      <para>
437       Add configure argument to optimistically redefine FD_SETSIZE
438       with the intent to change the maximum number of client
439       connections Privoxy can handle. Only works with some libcs.
440       Sponsored by Robert Klemme.
441      </para>
442     </listitem>
443     <listitem>
444      <para>
445       Let the tarball-dist target skip files in ".git".
446      </para>
447     </listitem>
448     <listitem>
449      <para>
450       Let the tarball-dist target work in cwds other than current.
451      </para>
452     </listitem>
453     <listitem>
454      <para>
455       Make the 'clean' target faster when run from a git repository.
456      </para>
457     </listitem>
458     <listitem>
459      <para>
460       Include tools in the generic distribution.
461      </para>
462     </listitem>
463     <listitem>
464      <para>
465       Let the gen-dist target work in cwds other than current.
466      </para>
467     </listitem>
468     <listitem>
469      <para>
470       Sort find output that is used for distribution tarballs
471       to get reproducible results.
472      </para>
473     </listitem>
474     <listitem>
475      <para>
476       Don't add '-src' to the name of the tar ball generated by the
477       gen-dist target. The package isn't a source distribution but a
478       binary package.
479       While at it, use a variable for the name to reduce the chances
480       that the various references get out of sync and fix the gen-upload
481       target which was looking in the wrong directory.
482      </para>
483     </listitem>
484     <listitem>
485      <para>
486       Add regression-tests.action to the files that are distributed.
487      </para>
488     </listitem>
489     <listitem>
490      <para>
491       The gen-dist target which was broken since 2002 (r1.92) has been fixed.
492      </para>
493     </listitem>
494     <listitem>
495      <para>
496       Remove genclspec.sh which has been obsolete since 2009.
497      </para>
498     </listitem>
499     <listitem>
500      <para>
501       Remove obsolete reference to Redhat spec file.
502      </para>
503     </listitem>
504     <listitem>
505      <para>
506       Remove the obsolete announce target which has been commented out years ago.
507      </para>
508     </listitem>
509     <listitem>
510      <para>
511       Let rsync skip files if the checksums match.
512      </para>
513      </listitem>
514     </itemizedlist>
515    </para>
516   </listitem>
517   <listitem>
518    <para>
519     Privoxy-Regression-Test:
520     <itemizedlist>
521     <listitem>
522      <para>
523       Add a "Default level offset" directive which can be used to
524       change the default level by a given value.
525       This directive affects all tests located after it until the end
526       of the file or a another "Default level offset" directive is reached.
527       The purpose of this directive is to make it more convenient to skip
528       similar tests in a given file without having to remove or disable
529       the tests completely.
530      </para>
531     </listitem>
532     <listitem>
533      <para>
534       Let test level 17 depend on FEATURE_64_BIT_TIME_T
535       instead of FEATURE_PTHREAD which has no direct connection
536       to the time_t size.
537      </para>
538     </listitem>
539     <listitem>
540      <para>
541       Fix indentation in perldoc examples.
542      </para>
543     </listitem>
544     <listitem>
545      <para>
546       Don't overlook directives in the first line of the action file.
547      </para>
548     </listitem>
549     <listitem>
550      <para>
551       Bump version to 0.7.
552      </para>
553     </listitem>
554     <listitem>
555      <para>
556       Fix detection of the Privoxy version now that https://
557       is used for the website.
558      </para>
559      </listitem>
560     </itemizedlist>
561    </para>
562   </listitem>
563  </itemizedlist>
564 </para>