]> git.ipfire.org Git - thirdparty/squid.git/commitdiff
Docs: auto-build release notes for snapshots
authorAmos Jeffries <squid3@treenet.co.nz>
Sun, 23 Aug 2015 11:53:54 +0000 (04:53 -0700)
committerAmos Jeffries <squid3@treenet.co.nz>
Sun, 23 Aug 2015 11:53:54 +0000 (04:53 -0700)
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.

Makefile.am
configure.ac
doc/Makefile.am
doc/release-notes/Makefile.am [moved from doc/release-notes/Makefile with 67% similarity]
doc/release-notes/release-4.html [deleted file]

index af93898b34495307f9454395c4ed11156befffed..9e750c9961806cb8f6048539853e67c5bcc8ff8e 100644 (file)
@@ -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 \
index 84cec41d455b81bf0f89c08066dc69d3f4aa4067..8d1469501921aa9cf1563dbe049d4ecfc4ab61ce 100644 (file)
@@ -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
index b8af8363e1ff268f59e27c6f66f1874036085ce4..7f413e25c74292a6a823ba5a8b87b0930b63c876 100644 (file)
@@ -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
similarity index 67%
rename from doc/release-notes/Makefile
rename to doc/release-notes/Makefile.am
index 73e43125ea72e6c7879af6a88084db4054c06cee..32b572e8fd6d02f11fbc53830fc9181d8ee833d5 100644 (file)
@@ -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 (file)
index 2718fae..0000000
+++ /dev/null
@@ -1,376 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<HTML>
-<HEAD>
- <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.69">
- <TITLE>Squid 4.0.0 release notes</TITLE>
-</HEAD>
-<BODY>
-<H1>Squid 4.0.0 release notes</H1>
-
-<H2>Squid Developers</H2>
-<HR>
-<EM>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.</EM>
-<HR>
-<P>
-<H2><A NAME="toc1">1.</A> <A HREF="#s1">Notice</A></H2>
-
-<UL>
-<LI><A NAME="toc1.1">1.1</A> <A HREF="#ss1.1">Known issues</A>
-<LI><A NAME="toc1.2">1.2</A> <A HREF="#ss1.2">Changes since earlier releases of Squid-4</A>
-</UL>
-<P>
-<H2><A NAME="toc2">2.</A> <A HREF="#s2">Major new features since Squid-3.5</A></H2>
-
-<UL>
-<LI><A NAME="toc2.1">2.1</A> <A HREF="#ss2.1">Configurable helper queue size</A>
-<LI><A NAME="toc2.2">2.2</A> <A HREF="#ss2.2">Helper concurrency channels changes</A>
-<LI><A NAME="toc2.3">2.3</A> <A HREF="#ss2.3">SSLv2 support removal</A>
-<LI><A NAME="toc2.4">2.4</A> <A HREF="#ss2.4">MSNT-multi-domain helper removal</A>
-</UL>
-<P>
-<H2><A NAME="toc3">3.</A> <A HREF="#s3">Changes to squid.conf since Squid-3.5</A></H2>
-
-<UL>
-<LI><A NAME="toc3.1">3.1</A> <A HREF="#ss3.1">New tags</A>
-<LI><A NAME="toc3.2">3.2</A> <A HREF="#ss3.2">Changes to existing tags</A>
-<LI><A NAME="toc3.3">3.3</A> <A HREF="#ss3.3">Removed tags</A>
-</UL>
-<P>
-<H2><A NAME="toc4">4.</A> <A HREF="#s4">Changes to ./configure options since Squid-3.5</A></H2>
-
-<UL>
-<LI><A NAME="toc4.1">4.1</A> <A HREF="#ss4.1">New options</A>
-<LI><A NAME="toc4.2">4.2</A> <A HREF="#ss4.2">Changes to existing options</A>
-<LI><A NAME="toc4.3">4.3</A> <A HREF="#ss4.3">Removed options</A>
-</UL>
-<P>
-<H2><A NAME="toc5">5.</A> <A HREF="#s5">Regressions since Squid-2.7</A></H2>
-
-<UL>
-<LI><A NAME="toc5.1">5.1</A> <A HREF="#ss5.1">Missing squid.conf options available in Squid-2.7</A>
-</UL>
-<P>
-<H2><A NAME="toc6">6.</A> <A HREF="#s6">Copyright</A></H2>
-
-
-<HR>
-<H2><A NAME="s1">1.</A> <A HREF="#toc1">Notice</A></H2>
-
-<P>The Squid Team are pleased to announce the release of Squid-4.0.0 for testing.</P>
-<P>This new release is available for download from 
-<A HREF="http://www.squid-cache.org/Versions/v4/">http://www.squid-cache.org/Versions/v4/</A> or the
-<A HREF="http://www.squid-cache.org/Download/http-mirrors.html">mirrors</A>.</P>
-
-<P>While this release is not deemed ready for production use, we believe it is ready for wider testing by the community.</P>
-
-<P>We welcome feedback and bug reports. If you find a bug, please see 
-<A HREF="http://wiki.squid-cache.org/SquidFaq/BugReporting">http://wiki.squid-cache.org/SquidFaq/BugReporting</A>
-for how to submit a report with a stack trace.</P>
-
-<H2><A NAME="ss1.1">1.1</A> <A HREF="#toc1.1">Known issues</A>
-</H2>
-
-<P>Although this release is deemed good enough for use in many setups, please note the existence of 
-<A HREF="http://bugs.squid-cache.org/buglist.cgi?query_format=advanced&amp;product=Squid&amp;bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;version=4">open bugs against Squid-4</A>.</P>
-
-<H2><A NAME="ss1.2">1.2</A> <A HREF="#toc1.2">Changes since earlier releases of Squid-4</A>
-</H2>
-
-<P>The Squid-4 change history can be 
-<A HREF="http://www.squid-cache.org/Versions/v4/changesets/">viewed here</A>.</P>
-
-
-<H2><A NAME="s2">2.</A> <A HREF="#toc2">Major new features since Squid-3.5</A></H2>
-
-<P>Squid 4 represents a new feature release above 3.5.</P>
-
-<P>The most important of these new features are:
-<UL>
-<LI>Helper concurrency channels changes</LI>
-<LI>Configurable helper queue size</LI>
-<LI>SSLv2 support removal</LI>
-<LI>MSNT-multi-domain helper removal</LI>
-</UL>
-</P>
-<P>Most user-facing changes are reflected in squid.conf (see below).</P>
-
-
-<H2><A NAME="ss2.1">2.1</A> <A HREF="#toc2.1">Configurable helper queue size</A>
-</H2>
-
-<P>The new queue-size=N option to helpers configuration, allows users 
-to configure the maximum number of queued requests to busy helpers.</P>
-
-<H2><A NAME="ss2.2">2.2</A> <A HREF="#toc2.2">Helper concurrency channels changes</A>
-</H2>
-
-<P> 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.</P>
-
-<P> 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.</P>
-
-<P> 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.</P>
-
-<H2><A NAME="ss2.3">2.3</A> <A HREF="#toc2.3">SSLv2 support removal</A>
-</H2>
-
-<P>Details in 
-<A HREF="https://tools.ietf.org/html/rfc6176">RFC 6176</A></P>
-
-<P>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.</P>
-
-
-<H2><A NAME="ss2.4">2.4</A> <A HREF="#toc2.4">MSNT-multi-domain helper removal</A>
-</H2>
-
-<P>The <EM>basic_msnt_multi_domain_auth</EM> helper has been removed. The
-<EM>basic_smb_lm_auth</EM> helper performs the same actions without extra
-Perl and Samba dependencies.</P>
-
-
-<H2><A NAME="s3">3.</A> <A HREF="#toc3">Changes to squid.conf since Squid-3.5</A></H2>
-
-<P>There have been changes to Squid's configuration file since Squid-3.5.</P>
-<P>This section gives a thorough account of those changes in three categories:</P>
-<P>
-<UL>
-<LI>
-<A HREF="#newtags">New tags</A></LI>
-<LI>
-<A HREF="#modifiedtags">Changes to existing tags</A></LI>
-<LI>
-<A HREF="#removedtags">Removed tags</A></LI>
-</UL>
-</P>
-
-
-<H2><A NAME="newtags"></A> <A NAME="ss3.1">3.1</A> <A HREF="#toc3.1">New tags</A>
-</H2>
-
-<P>
-<DL>
-<DT><B>tls_outgoing_options</B><DD>
-<P>New tag to define TLS security context options for outgoing
-connections. For example to HTTPS servers.</P>
-
-<DT><B>url_rewrite_timeout</B><DD>
-<P>Squid times active requests to redirector. This option sets
-the timeout value and the Squid reaction to a timed out
-request.</P>
-
-</DL>
-</P>
-
-<H2><A NAME="modifiedtags"></A> <A NAME="ss3.2">3.2</A> <A HREF="#toc3.2">Changes to existing tags</A>
-</H2>
-
-<P>
-<DL>
-<DT><B>auth_param</B><DD>
-<P>New parameter <EM>queue-size=</EM> to set the maximum number
-of queued requests.</P>
-
-<DT><B>cache_peer</B><DD>
-<P>All <EM>ssloption=</EM> and <EM>sslversion=</EM> values for
-SSLv2 configuration or disabling have been removed.</P>
-<P>Manual squid.conf update may be required on upgrade.</P>
-
-<DT><B>external_acl_type</B><DD>
-<P>New parameter <EM>queue-size=</EM> to set the maximum number
-of queued requests.</P>
-
-<DT><B>http_port</B><DD>
-<P>All <EM>version=</EM> <EM>option=</EM> values for SSLv2
-configuration or disabling have been removed.</P>
-<P>Manual squid.conf update may be required on upgrade.</P>
-
-<DT><B>https_port</B><DD>
-<P>All <EM>version=</EM> <EM>option=</EM> values for SSLv2
-configuration or disabling have been removed.</P>
-<P>Manual squid.conf update may be required on upgrade.</P>
-
-<DT><B>sslcrtd_children</B><DD>
-<P>New parameter <EM>queue-size=</EM> to set the maximum number
-of queued requests.</P>
-
-<DT><B>sslcrtvalidator_children</B><DD>
-<P>New parameter <EM>queue-size=</EM> to set the maximum number
-of queued requests.</P>
-
-<DT><B>sslproxy_options</B><DD>
-<P>All values for SSLv2 configuration or disabling have been removed.</P>
-<P>Manual squid.conf update may be required on upgrade.</P>
-
-<DT><B>sslproxy_version</B><DD>
-<P>Value '2' for SSLv2-only operation is no longer supported.</P>
-
-<DT><B>url_rewrite_children</B><DD>
-<P>New parameter <EM>queue-size=</EM> to set the maximum number
-of queued requests.</P>
-
-</DL>
-</P>
-
-<H2><A NAME="removedtags"></A> <A NAME="ss3.3">3.3</A> <A HREF="#toc3.3">Removed tags</A>
-</H2>
-
-<P>
-<DL>
-<DT><B>cache_peer_domain</B><DD>
-<P>Superceded by <EM>cache_peer_access</EM>. Use dstdomain ACL
-in the access control list to restrict domains requested.</P>
-
-<DT><B>refresh_pattern</B><DD>
-<P>Option <EM>ignore-auth</EM> 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.</P>
-
-<DT><B>sslproxy_cafile</B><DD>
-<P>Replaced by <EM>tls_outgoing_options cafile=</EM>.</P>
-
-<DT><B>sslproxy_capath</B><DD>
-<P>Replaced by <EM>tls_outgoing_options capath=</EM>.</P>
-
-<DT><B>sslproxy_cipher</B><DD>
-<P>Replaced by <EM>tls_outgoing_options cipher=</EM>.</P>
-
-<DT><B>sslproxy_client_certificate</B><DD>
-<P>Replaced by <EM>tls_outgoing_options cert=</EM>.</P>
-
-<DT><B>sslproxy_client_key</B><DD>
-<P>Replaced by <EM>tls_outgoing_options key=</EM>.</P>
-
-<DT><B>sslproxy_flags</B><DD>
-<P>Replaced by <EM>tls_outgoing_options flags=</EM>.</P>
-
-<DT><B>sslproxy_options</B><DD>
-<P>Replaced by <EM>tls_outgoing_options options=</EM>.</P>
-
-<DT><B>sslproxy_version</B><DD>
-<P>Replaced by <EM>tls_outgoing_options version=</EM>.</P>
-
-</DL>
-</P>
-
-
-<H2><A NAME="s4">4.</A> <A HREF="#toc4">Changes to ./configure options since Squid-3.5</A></H2>
-
-<P>There have been some changes to Squid's build configuration since Squid-3.5.</P>
-<P>This section gives an account of those changes in three categories:</P>
-<P>
-<UL>
-<LI>
-<A HREF="#newoptions">New options</A></LI>
-<LI>
-<A HREF="#modifiedoptions">Changes to existing options</A></LI>
-<LI>
-<A HREF="#removedoptions">Removed options</A></LI>
-</UL>
-</P>
-
-
-<H2><A NAME="newoptions"></A> <A NAME="ss4.1">4.1</A> <A HREF="#toc4.1">New options</A>
-</H2>
-
-<P>
-<DL>
-
-</DL>
-</P>
-
-<H2><A NAME="modifiedoptions"></A> <A NAME="ss4.2">4.2</A> <A HREF="#toc4.2">Changes to existing options</A>
-</H2>
-
-<P>
-<DL>
-<DT><B>--enable-auth-basic</B><DD>
-<P>The <EM>MSNT-multi-domain</EM> helper has been removed.</P>
-
-</DL>
-</P>
-<H2><A NAME="removedoptions"></A> <A NAME="ss4.3">4.3</A> <A HREF="#toc4.3">Removed options</A>
-</H2>
-
-<P>
-<DL>
-
-</DL>
-</P>
-
-
-<H2><A NAME="s5">5.</A> <A HREF="#toc5">Regressions since Squid-2.7</A></H2>
-
-<P>Some squid.conf options which were available in Squid-2.7 are not yet available in Squid-4</P>
-
-<P>If you need something to do then porting one of these from Squid-2 to Squid-3 is most welcome.</P>
-
-<H2><A NAME="ss5.1">5.1</A> <A HREF="#toc5.1">Missing squid.conf options available in Squid-2.7</A>
-</H2>
-
-<P>
-<DL>
-<DT><B>broken_vary_encoding</B><DD>
-<P>Not yet ported from 2.6</P>
-
-<DT><B>cache_peer</B><DD>
-<P><EM>monitorinterval=</EM> not yet ported from 2.6</P>
-<P><EM>monitorsize=</EM> not yet ported from 2.6</P>
-<P><EM>monitortimeout=</EM> not yet ported from 2.6</P>
-<P><EM>monitorurl=</EM> not yet ported from 2.6</P>
-
-<DT><B>cache_vary</B><DD>
-<P>Not yet ported from 2.6</P>
-
-<DT><B>error_map</B><DD>
-<P>Not yet ported from 2.6</P>
-
-<DT><B>external_refresh_check</B><DD>
-<P>Not yet ported from 2.7</P>
-
-<DT><B>location_rewrite_access</B><DD>
-<P>Not yet ported from 2.6</P>
-
-<DT><B>location_rewrite_children</B><DD>
-<P>Not yet ported from 2.6</P>
-
-<DT><B>location_rewrite_concurrency</B><DD>
-<P>Not yet ported from 2.6</P>
-
-<DT><B>location_rewrite_program</B><DD>
-<P>Not yet ported from 2.6</P>
-
-<DT><B>refresh_pattern</B><DD>
-<P><EM>stale-while-revalidate=</EM> not yet ported from 2.7</P>
-<P><EM>ignore-stale-while-revalidate=</EM> not yet ported from 2.7</P>
-<P><EM>negative-ttl=</EM> not yet ported from 2.7</P>
-
-<DT><B>refresh_stale_hit</B><DD>
-<P>Not yet ported from 2.7</P>
-
-<DT><B>update_headers</B><DD>
-<P>Not yet ported from 2.7</P>
-
-</DL>
-</P>
-
-<H2><A NAME="s6">6.</A> <A HREF="#toc6">Copyright</A></H2>
-
-<P>Copyright (C) 1996-2015 The Squid Software Foundation and contributors</P>
-<P>Squid software is distributed under GPLv2+ license and includes
-contributions from numerous individuals and organizations.
-Please see the COPYING and CONTRIBUTORS files for details.</P>
-
-</BODY>
-</HTML>