]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
CHANGES: rename to CHANGES.md, no longer generated
authorDaniel Stenberg <daniel@haxx.se>
Thu, 1 Aug 2024 07:58:31 +0000 (09:58 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Thu, 1 Aug 2024 11:37:12 +0000 (13:37 +0200)
- scripts/log2changes.pl was not included in release tarballs, which broke
  reproducible builds

- since log2changes uses git to generate the contents, it makes it difficult
  to generate the same contents later (it would need to be fixed)

- the CHANGES file has outlived its purpose. the main changes are in the
  RELEASE-NOTES, the rest are better tracked directly using git or on GitHub

- put a fixed CHANGES.md in there instead pointing out where the info lives
  now

Closes #14331

.github/labeler.yml
.gitignore
CHANGES [deleted file]
CHANGES.md [new file with mode: 0644]
Makefile.am
REUSE.toml
maketgz
packages/OS400/makefile.sh
scripts/log2changes.pl [deleted file]

index 43d42808f3354f511c8b33f1dca702ecb2464021..db742f7168a52f67814a3545124afacb01c333a8 100644 (file)
@@ -92,7 +92,7 @@ documentation:
   - all:
       - changed-files:
           - any-glob-to-all-files:
-              - '{.github/workflows/badwords.yml,.github/workflows/man-examples.yml,.github/workflows/synopsis.yml,.github/scripts/badwords.*,.github/scripts/cd2cd,.github/scripts/cd2nroff,.github/scripts/cdall.pl,.github/scripts/nroff2cd,.github/scripts/verify-examples.pl,.github/scripts/verify-synopsis.pl,**/*.md,**/*.txt,**/*.1,CHANGES,docs/**,LICENSES/**,README,RELEASE-NOTES,scripts/cd*}'
+              - '{.github/workflows/badwords.yml,.github/workflows/man-examples.yml,.github/workflows/synopsis.yml,.github/scripts/badwords.*,.github/scripts/cd2cd,.github/scripts/cd2nroff,.github/scripts/cdall.pl,.github/scripts/nroff2cd,.github/scripts/verify-examples.pl,.github/scripts/verify-synopsis.pl,**/*.md,**/*.txt,**/*.1,CHANGES.md,docs/**,LICENSES/**,README,RELEASE-NOTES,scripts/cd*}'
           - all-globs-to-all-files:
               # negative matches
               - '!**/CMakeLists.txt'
index 6d1e69ed04b589f1712389ba90106410fc716074..a9099e5ce42b85402e22f33092401a3515520bf2 100644 (file)
@@ -27,7 +27,6 @@
 /builds/
 /stats/
 __pycache__
-CHANGES.dist
 Debug
 INSTALL
 Makefile
diff --git a/CHANGES b/CHANGES
deleted file mode 100644 (file)
index 3e2cd99..0000000
--- a/CHANGES
+++ /dev/null
@@ -1,7 +0,0 @@
-See https://curl.se/changes.html for the edited and human readable online
-version of what has changed over the years in different curl releases.
-
-Generate a CHANGES file like the one present in every release like this:
-
-$ git log --pretty=fuller --no-color --date=short --decorate=full | \
-  ./scripts/log2changes.pl
diff --git a/CHANGES.md b/CHANGES.md
new file mode 100644 (file)
index 0000000..6e2f7c6
--- /dev/null
@@ -0,0 +1,12 @@
+<!--
+Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
+
+SPDX-License-Identifier: curl
+-->
+
+In a release tarball, check the RELEASES-NOTES file for what was done in the
+most recent release. In a git check-out, that file mentions changes that have
+been done since the previous release.
+
+See the online [changelog](https://curl.se/changes.html) for the edited and
+human readable version of what has changed in different curl releases.
index ffd319457c00294c089b15ee81fa6d827ed994c0..62b35a53540344cd121b2d3a984ec4cf9c3ba825 100644 (file)
@@ -75,7 +75,7 @@ PLAN9_DIST = plan9/include/mkfile \
  plan9/src/mkfile.inc             \
  plan9/src/mkfile
 
-EXTRA_DIST = CHANGES COPYING maketgz Makefile.dist curl-config.in       \
+EXTRA_DIST = CHANGES.md COPYING maketgz Makefile.dist curl-config.in       \
  RELEASE-NOTES buildconf libcurl.pc.in $(CMAKE_DIST) $(VC_DIST)         \
  $(WINBUILD_DIST) $(PLAN9_DIST) lib/libcurl.vers.in buildconf.bat       \
  libcurl.def Dockerfile
index c973868b439e5bb38d6501a7056625ca653f9155..93c50dd71fe3e5a04ee073df42feefd843a8bfa0 100644 (file)
@@ -14,7 +14,6 @@ SPDX-PackageDownloadLocation = "https://curl.se/"
 [[annotations]]
 path = [
   ".mailmap",
-  "CHANGES",
   "docs/FAQ",
   "docs/INSTALL",
   "docs/KNOWN_BUGS",
diff --git a/maketgz b/maketgz
index 0492371a9fbc6cd571c90428f0c207b8f5798fd6..18749448cf7090884246871b0a107857d0ffeb37 100755 (executable)
--- a/maketgz
+++ b/maketgz
@@ -146,9 +146,6 @@ else
   automake --include-deps Makefile >/dev/null
 fi
 
-echo "produce CHANGES"
-git log --pretty=fuller --no-color --date=short --decorate=full -1000 | ./scripts/log2changes.pl > CHANGES.dist
-
 echo "produce RELEASE-TOOLS.md"
 ./scripts/release-tools.sh "$timestamp" "$version" > docs/RELEASE-TOOLS.md.dist
 
index fb1f1467132ca339450975d67031d43258ae235e..7f75845215895b2fcc4d2363efa928cc3781dc3c 100755 (executable)
@@ -65,7 +65,7 @@ fi
 #       Copy some documentation files if needed.
 
 for TEXT in "${TOPDIR}/COPYING" "${SCRIPTDIR}/README.OS400"             \
-    "${TOPDIR}/CHANGES" "${TOPDIR}/docs/THANKS" "${TOPDIR}/docs/FAQ"    \
+    "${TOPDIR}/CHANGES.md" "${TOPDIR}/docs/THANKS" "${TOPDIR}/docs/FAQ"    \
     "${TOPDIR}/docs/FEATURES" "${TOPDIR}/docs/SSLCERTS.md"              \
     "${TOPDIR}/docs/RESOURCES" "${TOPDIR}/docs/VERSIONS.md"             \
     "${TOPDIR}/docs/HISTORY.md"
diff --git a/scripts/log2changes.pl b/scripts/log2changes.pl
deleted file mode 100755 (executable)
index 3554183..0000000
+++ /dev/null
@@ -1,103 +0,0 @@
-#!/usr/bin/env perl
-#***************************************************************************
-#                                  _   _ ____  _
-#  Project                     ___| | | |  _ \| |
-#                             / __| | | | |_) | |
-#                            | (__| |_| |  _ <| |___
-#                             \___|\___/|_| \_\_____|
-#
-# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
-#
-# This software is licensed as described in the file COPYING, which
-# you should have received as part of this distribution. The terms
-# are also available at https://curl.se/docs/copyright.html.
-#
-# You may opt to use, copy, modify, merge, publish, distribute and/or sell
-# copies of the Software, and permit persons to whom the Software is
-# furnished to do so, under the terms of the COPYING file.
-#
-# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
-# KIND, either express or implied.
-#
-# SPDX-License-Identifier: curl
-#
-###########################################################################
-
-# git log --pretty=fuller --no-color --date=short --decorate=full
-
-my @mname = ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
-             'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' );
-
-sub nicedate {
-    my ($date)=$_;
-
-    if($date =~ /(\d\d\d\d)-(\d\d)-(\d\d)/) {
-        return sprintf("%d %s %4d", $3, $mname[$2-1], $1);
-    }
-    return $date;
-}
-
-sub printmsg {
-    my ($p, $msg)=@_;
-    while(length($msg) > 77) {
-        print $p.substr($msg, 0, 77, "")."\n";
-        $p="  ";
-    }
-    if($msg eq "") {
-        $p = "";
-    }
-    print "$p$msg\n";
-}
-
-print
-'                                  _   _ ____  _
-                              ___| | | |  _ \| |
-                             / __| | | | |_) | |
-                            | (__| |_| |  _ <| |___
-                             \___|\___/|_| \_\_____|
-
-                                  Changelog
-';
-
-my $tag;
-while(<STDIN>) {
-    my $l = $_;
-
-    if($l =~/^commit ([[:xdigit:]]*) ?(.*)/) {
-        $co = $1;
-        my $ref = $2;
-        if ($ref =~ /refs\/tags\/curl-([0-9_]*)/) {
-            $tag = $1;
-            $tag =~ tr/_/./;
-        }
-    }
-    elsif($l =~ /^Author: *(.*) +</) {
-        $c = $1;
-    }
-    elsif($l =~ /^CommitDate: (.*)/) {
-        $date = nicedate($1);
-    }
-    elsif($l =~ /^(    )(.*)/) {
-        my $pref = "  ";
-        if ($tag) {
-            # Version entries have a special format
-            print "\nVersion " . $tag." ($date)\n";
-            $oldc = "";
-            $tag = "";
-        }
-        if($co ne $oldco) {
-            if($c ne $oldc) {
-                print "\n$c ($date)\n\n";
-            }
-            else {
-                print "\n";
-            }
-            $pref = "- ";
-        }
-
-        $oldco = $co;
-        $oldc = $c;
-        $olddate = $date;
-        printmsg($pref, $2);
-    }
-}