From: Amos Jeffries Date: Mon, 20 Feb 2023 07:05:13 +0000 (+0000) Subject: Maintenance: improve release notes automation (#1264) X-Git-Tag: SQUID_6_0_1~3 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c0789db1f479206e43f96add370363127834757a;p=thirdparty%2Fsquid.git Maintenance: improve release notes automation (#1264) * auto-update the text version numbers * add template for automatic series creation --- diff --git a/SPONSORS.list b/SPONSORS.list index 7ff03b7adb..2c691dcfec 100644 --- a/SPONSORS.list +++ b/SPONSORS.list @@ -163,6 +163,12 @@ SGI - http://www.sgi.com/ SGI has provided hardware donations for Squid developers. @Squid-2.3: +National Laboratory for Applied Network Research + + NLANR coordinated the early development of Squid + with features for integration with the IRCache network + measurement project and High Performance Networking. + The National Science Foundation The NSF was the primary funding source for Squid development diff --git a/doc/release-notes/Makefile.am b/doc/release-notes/Makefile.am index b5821c857e..8be79124db 100644 --- a/doc/release-notes/Makefile.am +++ b/doc/release-notes/Makefile.am @@ -10,6 +10,14 @@ if ENABLE_RELEASE_DOCS DOC= release-$(SQUID_RELEASE) +%.sgml: %.sgml.in + sed \ + -e "s%[@]SQUID_VERSION[@]%$(VERSION)%g" \ + -e "s%[@]SQUID_RELEASE[@]%$(SQUID_RELEASE)%g" \ + -e "s%[@]SQUID_RELEASE_OLD[@]%$$(( $(SQUID_RELEASE) - 1 ))%g" \ + < $< >$@ + test `grep -c "@SQUID" $@` -eq 0 + %.txt: %.sgml linuxdoc -B txt --filter $< diff --git a/doc/release-notes/release-5.sgml b/doc/release-notes/release-5.sgml.in similarity index 93% rename from doc/release-notes/release-5.sgml rename to doc/release-notes/release-5.sgml.in index 3929c11860..1705620486 100644 --- a/doc/release-notes/release-5.sgml +++ b/doc/release-notes/release-5.sgml.in @@ -1,36 +1,30 @@
-Squid 5.7 release notes +Squid @SQUID_VERSION@ release notes Squid Developers - -This document contains the release notes for version 5 of Squid. -Squid is a WWW Cache application developed by the National Laboratory -for Applied Network Research and members of the Web Caching community. - - Notice -

The Squid Team are pleased to announce the release of Squid-5.7. +

The Squid Team are pleased to announce the release of Squid-@SQUID_VERSION@. -This new release is available for download from or the +This new release is available for download from or the . -

We welcome feedback and bug reports. If you find a bug, please see +

We welcome feedback and bug reports. If you find a bug, please see for how to submit a report with a stack trace. Known issues

Although this release is deemed good enough for use in many setups, please note the existence of -. +. -Changes since earlier releases of Squid-5 +Changes since earlier releases of Squid-@SQUID_RELEASE@

-The Squid-5 change history can be . +The Squid-@SQUID_RELEASE@ change history can be . -Major new features since Squid-4 -

Squid-5 represents a new feature release above Squid-4. +Major new features since Squid-@SQUID_RELEASE_OLD@ +

Squid-@SQUID_RELEASE@ represents a new feature release above Squid-@SQUID_RELEASE_OLD@.

The most important of these new features are: @@ -165,9 +159,9 @@ Most user-facing changes are reflected in squid.conf (see below).

OpenSSL 3.0 uses new licensing terms. -Changes to squid.conf since Squid-4 +Changes to squid.conf since Squid-@SQUID_RELEASE_OLD@

-There have been changes to Squid's configuration file since Squid-4. +There have been changes to Squid's configuration file since Squid-@SQUID_RELEASE_OLD@. This section gives a thorough account of those changes in three categories: @@ -326,9 +320,9 @@ This section gives a thorough account of those changes in three categories: -Changes to ./configure options since Squid-4 +Changes to ./configure options since Squid-@SQUID_RELEASE_OLD@

-There have been some changes to Squid's build configuration since Squid-4. +There have been some changes to Squid's build configuration since Squid-@SQUID_RELEASE_OLD@. This section gives an account of those changes in three categories: @@ -385,7 +379,7 @@ This section gives an account of those changes in three categories: Regressions since Squid-2.7 -

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

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

If you need something to do then porting one of these from Squid-2 is most welcome. diff --git a/doc/release-notes/release-6.sgml b/doc/release-notes/release-6.sgml.in similarity index 94% rename from doc/release-notes/release-6.sgml rename to doc/release-notes/release-6.sgml.in index 6856d643ed..05a1f81a76 100644 --- a/doc/release-notes/release-6.sgml +++ b/doc/release-notes/release-6.sgml.in @@ -1,21 +1,14 @@

-Squid 6.0.1 release notes +Squid @SQUID_VERSION@ release notes Squid Developers - -This document contains the release notes for version 6 of Squid. -Squid is a WWW Cache application developed by the National Laboratory -for Applied Network Research and members of the Web Caching community. - - - Notice -

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

The Squid Team are pleased to announce the release of Squid-@SQUID_VERSION@ for testing. -This new release is available for download from or the +This new release is available for download from or the .

While this release is not deemed ready for production use, we believe it is ready for wider testing by the community. @@ -25,7 +18,7 @@ This new release is available for download from . +.

Support for compiling on HPUX with the native HP xcc compiler has been removed. To build on that OS/compiler combination, it is possible to pass these environment variables @@ -34,13 +27,13 @@ This new release is available for download from . +The Squid-@SQUID_RELEASE@ change history can be . -Major new features since Squid-5 -

Squid-6 represents a new feature release above Squid-5. +Major new features since Squid-@SQUID_RELEASE_OLD@ +

Squid-@SQUID_RELEASE@ represents a new feature release above Squid-@SQUID_RELEASE_OLD@.

The most important of these new features are: @@ -196,7 +189,7 @@ The Squid-6 change history can be or the + . + +

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 + for how to submit a report with a stack trace. + +Known issues +

Although this release is deemed good enough for use in many setups, please note the existence of +. + +Changes since earlier releases of Squid-@SQUID_RELEASE@ +

+The Squid-@SQUID_RELEASE@ change history can be . + + +Major new features since Squid-@SQUID_RELEASE_OLD@ +

Squid-@SQUID_RELEASE@ represents a new feature release above Squid-@SQUID_RELEASE_OLD@. + +

The most important of these new features are: + + + + +Most user-facing changes are reflected in squid.conf (see below). + + +Changes to squid.conf since Squid-@SQUID_RELEASE_OLD@ +

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

+ +New directives

+ +

No new directives in this version. + + + +Changes to existing directives

+ +

No changed directives in this version. + + + +Removed directives

+ +

No removed directives in this version. + + + + +Changes to ./configure options since Squid-@SQUID_RELEASE_OLD@ +

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

+ +

No new options in this version. + + + +Changes to existing options

+ +

No changed options in this version. + + +

+ +Removed options