[PATCH] Drop dependency of dist target on ChangeLog

[PATCH] Drop dependency of dist target on ChangeLog

[Siddhesh Poyarekar]

We no longer write manual ChangeLog entries since they are
auto-generated at release time.  Drop dependency of the `make dist`
target on the file and document the fact that the latest ChangeLog
entries can be read in the highest numbered ChangeLog.N file in
ChangeLog.old.

The ChangeLog.old/ChangeLog.20 file for 2.31 will thus be generated
just before tagging a release.
---
 Makefile        | 2 +-
 NEWS            | 4 ++++
 timezone/README | 4 ++--
 3 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/Makefile b/Makefile
index 3dafcec2b2..8f0a93aceb 100644
--- a/Makefile
+++ b/Makefile
@@ -673,7 +673,7 @@ TAGS:
 
 generated := $(generated) stubs.h
 
-files-for-dist := README INSTALL configure ChangeLog NEWS
+files-for-dist := README INSTALL configure NEWS
 
 # Regenerate stuff, then error if these things are not committed yet.
 dist-prepare: $(files-for-dist)
diff --git a/NEWS b/NEWS
index b85989ec3d..0ecee6c13b 100644
--- a/NEWS
+++ b/NEWS
@@ -104,6 +104,10 @@ Changes to build and runtime requirements:
 * It is no longer necessary to have recent Linux kernel headers to build
   working (non-stub) system call wrappers.
 
+* The ChangeLog file is no longer present in the toplevel directory of the
+  source tree.  ChangeLog files are located in the ChangeLog.old directory as
+  ChangeLog.N where the highest N has the latest entries.
+
 Security related changes:
 
   CVE-2019-19126: ld.so failed to ignore the LD_PREFER_MAP_32BIT_EXEC
diff --git a/timezone/README b/timezone/README
index fc50f1399f..fdfdcd9403 100644
--- a/timezone/README
+++ b/timezone/README
@@ -9,8 +9,8 @@ The files
 	iso3166.tab zone.tab leapseconds yearistype
 come from the tzdata package by Arthur David Olson et.al.
 
-Please check the ChangeLog files in the top level directory for the
-version of the tzcode and tzdata packages.
+Please check the ChangeLog files in ChangeLog.old directory at the top level
+for the version of the tzcode and tzdata packages.
 
 Please also see: https://sourceware.org/glibc/wiki/SharedSourceFiles
 
-- 
2.24.1

Re: [PATCH] Drop dependency of dist target on ChangeLog

[Paul Eggert]

[-- Attachment #1: Type: text/plain, Size: 414 bytes --]

This looks good, except for the change to timezone/README:

> +Please check the ChangeLog files in ChangeLog.old directory at the top level
> +for the version of the tzcode and tzdata packages.

It's awkward to have to paw through ChangeLog.old for version numbers, 
plus when I took the trouble to actually do that I found that the 
version numbers there were incorrect. So I propose the attached patch 
instead.

[-- Attachment #2: 0001-Update-timezone-README.patch --]
[-- Type: text/x-patch, Size: 2111 bytes --]

From 3c69ed681a2a2a290fabad120137d20d379a03dc Mon Sep 17 00:00:00 2001
From: Paul Eggert <eggert@cs.ucla.edu>
Date: Wed, 8 Jan 2020 17:48:49 -0800
Subject: [PATCH] Update timezone/README

* timezone/version: New file, also taken from tzcode2018i.
* timezone/README: Reword so that people needn't paw through
old ChangeLog files to see which version we're using, a process
that is error-prone.  Update an obsolescent URL.
---
 timezone/README  | 14 ++++++++------
 timezone/version |  1 +
 2 files changed, 9 insertions(+), 6 deletions(-)
 create mode 100644 timezone/version

diff --git a/timezone/README b/timezone/README
index fc50f1399f..da814e3bca 100644
--- a/timezone/README
+++ b/timezone/README
@@ -1,6 +1,7 @@
 The files
-	zic.c zdump.c tzfile.h private.h tzselect.ksh
+	zic.c zdump.c tzfile.h private.h tzselect.ksh version
 come from the tzcode package by Arthur David Olson et.al.
+The 'version' file specifies which tzcode version was used.
 
 The files
 	africa antarctica asia australasia europe
@@ -8,14 +9,15 @@ The files
 	backward systemv solar87 solar88 solar89
 	iso3166.tab zone.tab leapseconds yearistype
 come from the tzdata package by Arthur David Olson et.al.
-
-Please check the ChangeLog files in the top level directory for the
-version of the tzcode and tzdata packages.
+except that its 'yearistype.sh' file is renamed to 'yearistype'.
+These tzdata files were taken from tzdata 2009i and have not been
+updated since, as they do not affect a glibc installation and are
+present only for regression testing.
 
 Please also see: https://sourceware.org/glibc/wiki/SharedSourceFiles
 
-These packages may be found at ftp://ftp.iana.org/tz/releases/.  Commentary
-should be addressed to tz@iana.org.
+These packages may be found at https://ftp.iana.org/tz/releases/.
+Commentary should be addressed to tz@iana.org.
 
 The subdirectory testdata contains manually edited data files for
 regression testing purposes.
diff --git a/timezone/version b/timezone/version
new file mode 100644
index 0000000000..63f58006ee
--- /dev/null
+++ b/timezone/version
@@ -0,0 +1 @@
+2018i
-- 
2.24.1

Re: [PATCH] Drop dependency of dist target on ChangeLog

[Jonathan Nieder]

Paul Eggert wrote:

> It's awkward to have to paw through ChangeLog.old for version numbers, plus
> when I took the trouble to actually do that I found that the version numbers
> there were incorrect. So I propose the attached patch instead.
>
> * timezone/version: New file, also taken from tzcode2018i.
> * timezone/README: Reword so that people needn't paw through
> old ChangeLog files to see which version we're using, a process
> that is error-prone.  Update an obsolescent URL.
> ---
>  timezone/README  | 14 ++++++++------
>  timezone/version |  1 +
>  2 files changed, 9 insertions(+), 6 deletions(-)
>  create mode 100644 timezone/version

Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>

Thanks.

Re: [PATCH] Drop dependency of dist target on ChangeLog

[Siddhesh Poyarekar]

On 09/01/20 7:26 am, Paul Eggert wrote:
> This looks good, except for the change to timezone/README:
> 
>> +Please check the ChangeLog files in ChangeLog.old directory at the
>> top level
>> +for the version of the tzcode and tzdata packages.
> 
> It's awkward to have to paw through ChangeLog.old for version numbers,
> plus when I took the trouble to actually do that I found that the
> version numbers there were incorrect. So I propose the attached patch
> instead.

Perfect, thanks.  I'll commit my change without this doc update and you
can commit this one.

Siddhesh