From: Amos Jeffries Date: Sun, 23 Aug 2015 11:53:54 +0000 (-0700) Subject: Docs: auto-build release notes for snapshots X-Git-Tag: SQUID_4_0_1~116 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=86b8d4007571b7fd0af09d7f80782fa64b2a7b2a;p=thirdparty%2Fsquid.git Docs: auto-build release notes for snapshots This adds conditional build support to generate release notes whenever a tarball is being created, regardless of what the code branch status is. All that is required is the linuxdoc tool chain. Formal release branch snapshots have been publishing the notes files built for their previous release. But development versions of Squid have not been getting documented at all which can be annoying for testers. The release-N.html file is also removed from the repository. With this update it should no longer be needed by the snapshot machinery. --- diff --git a/Makefile.am b/Makefile.am index af93898b34..9e750c9961 100644 --- a/Makefile.am +++ b/Makefile.am @@ -27,16 +27,6 @@ dist-hook: rm -f $(distdir)/$$subdir/autoconf.h; \ fi; \ done - @if [ -f $(top_srcdir)/RELEASENOTES.html ]; then \ - cp -p $(top_srcdir)/RELEASENOTES.html $(distdir)/RELEASENOTES.html; \ - else \ - notes=`ls -1rt $(top_srcdir)/doc/release-notes/*.html | head -1`; \ - if [ -f $$notes ]; then \ - cp $$notes $(distdir)/RELEASENOTES.html; \ - else \ - touch $(distdir)/RELEASENOTES.html; \ - fi; \ - fi EXTRA_DIST = \ ChangeLog \ diff --git a/configure.ac b/configure.ac index 84cec41d45..8d14695019 100644 --- a/configure.ac +++ b/configure.ac @@ -129,6 +129,9 @@ fi AR_R="$AR r" AC_SUBST(AR_R) +AC_PATH_PROG(LINUXDOC, linuxdoc, $FALSE) +AM_CONDITIONAL(ENABLE_RELEASE_DOCS, test "x${ac_cv_path_LINUXDOC}" != "x$FALSE") + # pre-define DEFAULT_PREFIX, some modules need it. if test "${prefix}" = "NONE" ; then squid_prefix=$ac_default_prefix @@ -3780,6 +3783,7 @@ AC_CONFIG_FILES([ contrib/Makefile doc/Makefile doc/manuals/Makefile + doc/release-notes/Makefile errors/Makefile helpers/Makefile helpers/basic_auth/Makefile diff --git a/doc/Makefile.am b/doc/Makefile.am index b8af8363e1..7f413e25c7 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -5,7 +5,7 @@ ## Please see the COPYING and CONTRIBUTORS files for details. ## -SUBDIRS = manuals +SUBDIRS = manuals release-notes DEFAULT_CONFIG_FILE = $(sysconfdir)/squid.conf DEFAULT_MIME_TABLE = $(sysconfdir)/mime.conf diff --git a/doc/release-notes/Makefile b/doc/release-notes/Makefile.am similarity index 67% rename from doc/release-notes/Makefile rename to doc/release-notes/Makefile.am index 73e43125ea..32b572e8fd 100644 --- a/doc/release-notes/Makefile +++ b/doc/release-notes/Makefile.am @@ -5,7 +5,8 @@ ## Please see the COPYING and CONTRIBUTORS files for details. ## -all: release-4.html +# requires the linuxdoc tools +if ENABLE_RELEASE_DOCS DOC= release-4 @@ -24,11 +25,17 @@ $(DOC).ps: $(DOC).sgml %.html: %.sgml linuxdoc -B html -T 2 --split=0 $< perl -i -p -e "s%$@%%" $@ + cp -p $(DOC).html $(top_builddir)/RELEASENOTES.html %.man: %.sgml linuxdoc -B txt -T 2 -m $(DOC) -clean: - rm -f *.html - rm -f *.tex *.ps *.dvi *.aux *.log *.toc - rm -f *.txt *.man +EXTRA_DIST= $(DOC).html $(top_builddir)/RELEASENOTES.html + +CLEANFILES= \ + *.html \ + *.tex *.ps *.dvi *.aux *.log *.toc \ + *.txt *.man \ + $(top_builddir)/RELEASENOTES.html + +endif diff --git a/doc/release-notes/release-4.html b/doc/release-notes/release-4.html deleted file mode 100644 index 2718fae3f2..0000000000 --- a/doc/release-notes/release-4.html +++ /dev/null @@ -1,376 +0,0 @@ - - - - - Squid 4.0.0 release notes - - -

Squid 4.0.0 release notes

- -

Squid Developers

-
-This document contains the release notes for version 4 of Squid. -Squid is a WWW Cache application developed by the National Laboratory -for Applied Network Research and members of the Web Caching community. -
-

-

1. Notice

- - -

-

2. Major new features since Squid-3.5

- - -

-

3. Changes to squid.conf since Squid-3.5

- - -

-

4. Changes to ./configure options since Squid-3.5

- - -

-

5. Regressions since Squid-2.7

- - -

-

6. Copyright

- - -
-

1. Notice

- -

The Squid Team are pleased to announce the release of Squid-4.0.0 for testing.

-

This new release is available for download from -http://www.squid-cache.org/Versions/v4/ or the -mirrors.

- -

While this release is not deemed ready for production use, we believe it is ready for wider testing by the community.

- -

We welcome feedback and bug reports. If you find a bug, please see -http://wiki.squid-cache.org/SquidFaq/BugReporting -for how to submit a report with a stack trace.

- -

1.1 Known issues -

- -

Although this release is deemed good enough for use in many setups, please note the existence of -open bugs against Squid-4.

- -

1.2 Changes since earlier releases of Squid-4 -

- -

The Squid-4 change history can be -viewed here.

- - -

2. Major new features since Squid-3.5

- -

Squid 4 represents a new feature release above 3.5.

- -

The most important of these new features are: -

-

-

Most user-facing changes are reflected in squid.conf (see below).

- - -

2.1 Configurable helper queue size -

- -

The new queue-size=N option to helpers configuration, allows users -to configure the maximum number of queued requests to busy helpers.

- -

2.2 Helper concurrency channels changes -

- -

helper-mux.pl we have been distributing for the past few years to -encourage use of concurrency is no longer compatible with Squid. If -used it will spawn up to 2^64 helpers and DoS the Squid server.

- -

Helpers utilizing arrays to handle fixed amounts of concurrency -channels MUST be re-written to use queues and capable of handling a -64-bit int as index or they will be vulnerable to buffer overrun and -arbitrary memory accesses.

- -

32-bit helpers need re-writing to handle the concurrency channel ID -as a 64-bit integer value. If not updated they will cause proxies to -return unexpected results or timeout once crossing the 32-bit wrap -boundary. Leading to undefined behaviour in the client HTTP traffic.

- -

2.3 SSLv2 support removal -

- -

Details in -RFC 6176

- -

SSLv2 is not fit for purpose. Squid no longer supports being configured with -any settings regarding this protocol. That includes settings manually disabling -its use since it is now forced to disable by default. Also settings enabling -various client/server workarounds specific to SSLv2 are removed.

- - -

2.4 MSNT-multi-domain helper removal -

- -

The basic_msnt_multi_domain_auth helper has been removed. The -basic_smb_lm_auth helper performs the same actions without extra -Perl and Samba dependencies.

- - -

3. Changes to squid.conf since Squid-3.5

- -

There have been changes to Squid's configuration file since Squid-3.5.

-

This section gives a thorough account of those changes in three categories:

-

-

-

- - -

3.1 New tags -

- -

-

-
tls_outgoing_options
-

New tag to define TLS security context options for outgoing -connections. For example to HTTPS servers.

- -
url_rewrite_timeout
-

Squid times active requests to redirector. This option sets -the timeout value and the Squid reaction to a timed out -request.

- -
-

- -

3.2 Changes to existing tags -

- -

-

-
auth_param
-

New parameter queue-size= to set the maximum number -of queued requests.

- -
cache_peer
-

All ssloption= and sslversion= values for -SSLv2 configuration or disabling have been removed.

-

Manual squid.conf update may be required on upgrade.

- -
external_acl_type
-

New parameter queue-size= to set the maximum number -of queued requests.

- -
http_port
-

All version= option= values for SSLv2 -configuration or disabling have been removed.

-

Manual squid.conf update may be required on upgrade.

- -
https_port
-

All version= option= values for SSLv2 -configuration or disabling have been removed.

-

Manual squid.conf update may be required on upgrade.

- -
sslcrtd_children
-

New parameter queue-size= to set the maximum number -of queued requests.

- -
sslcrtvalidator_children
-

New parameter queue-size= to set the maximum number -of queued requests.

- -
sslproxy_options
-

All values for SSLv2 configuration or disabling have been removed.

-

Manual squid.conf update may be required on upgrade.

- -
sslproxy_version
-

Value '2' for SSLv2-only operation is no longer supported.

- -
url_rewrite_children
-

New parameter queue-size= to set the maximum number -of queued requests.

- -
-

- -

3.3 Removed tags -

- -

-

-
cache_peer_domain
-

Superceded by cache_peer_access. Use dstdomain ACL -in the access control list to restrict domains requested.

- -
refresh_pattern
-

Option ignore-auth removed. Its original intent was -to improve caching. HTTP/1.1 permits caching of authenticated -messages under conditions which Squid does check for and obey.

- -
sslproxy_cafile
-

Replaced by tls_outgoing_options cafile=.

- -
sslproxy_capath
-

Replaced by tls_outgoing_options capath=.

- -
sslproxy_cipher
-

Replaced by tls_outgoing_options cipher=.

- -
sslproxy_client_certificate
-

Replaced by tls_outgoing_options cert=.

- -
sslproxy_client_key
-

Replaced by tls_outgoing_options key=.

- -
sslproxy_flags
-

Replaced by tls_outgoing_options flags=.

- -
sslproxy_options
-

Replaced by tls_outgoing_options options=.

- -
sslproxy_version
-

Replaced by tls_outgoing_options version=.

- -
-

- - -

4. Changes to ./configure options since Squid-3.5

- -

There have been some changes to Squid's build configuration since Squid-3.5.

-

This section gives an account of those changes in three categories:

-

-

-

- - -

4.1 New options -

- -

-

- -
-

- -

4.2 Changes to existing options -

- -

-

-
--enable-auth-basic
-

The MSNT-multi-domain helper has been removed.

- -
-

-

4.3 Removed options -

- -

-

- -
-

- - -

5. Regressions since Squid-2.7

- -

Some squid.conf options which were available in Squid-2.7 are not yet available in Squid-4

- -

If you need something to do then porting one of these from Squid-2 to Squid-3 is most welcome.

- -

5.1 Missing squid.conf options available in Squid-2.7 -

- -

-

-
broken_vary_encoding
-

Not yet ported from 2.6

- -
cache_peer
-

monitorinterval= not yet ported from 2.6

-

monitorsize= not yet ported from 2.6

-

monitortimeout= not yet ported from 2.6

-

monitorurl= not yet ported from 2.6

- -
cache_vary
-

Not yet ported from 2.6

- -
error_map
-

Not yet ported from 2.6

- -
external_refresh_check
-

Not yet ported from 2.7

- -
location_rewrite_access
-

Not yet ported from 2.6

- -
location_rewrite_children
-

Not yet ported from 2.6

- -
location_rewrite_concurrency
-

Not yet ported from 2.6

- -
location_rewrite_program
-

Not yet ported from 2.6

- -
refresh_pattern
-

stale-while-revalidate= not yet ported from 2.7

-

ignore-stale-while-revalidate= not yet ported from 2.7

-

negative-ttl= not yet ported from 2.7

- -
refresh_stale_hit
-

Not yet ported from 2.7

- -
update_headers
-

Not yet ported from 2.7

- -
-

- -

6. Copyright

- -

Copyright (C) 1996-2015 The Squid Software Foundation and contributors

-

Squid software is distributed under GPLv2+ license and includes -contributions from numerous individuals and organizations. -Please see the COPYING and CONTRIBUTORS files for details.

- - -