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