all: Remove most in-file ChangeLogs and versioningtip

In-file ChangeLog information is no longer required in the modern VCS world, except where a file is imported as a version, eg bootstrap.sh, gitignore etc. In-file versioning should only be provided when it helps to narrow down bugs or problems. So they are valid as script / program version information which the user can quote when reporting bugs. They are not required on AutoTools files for example. Signed-off-by: Mark Grant <m.grant.prg@gmail.com>
m-grant-prg · Nov 5, 2023 · 387d20f · 387d20f
1 parent 8d58f57
commit 387d20f
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 339 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,6 +1,5 @@
 #########################################################################
 #									#
-# File ID: ./.github/dependabot.yml                                     #
 # Author: Copyright (C) 2023  Mark Grant				#
 #									#
 # Released under the GPLv3 only.					#
@@ -11,16 +10,6 @@
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 06/09/2023	MG	1.0.1	Initial release.                        #
-#									#
-#########################################################################
-
 
 version: 2
 updates:

diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
@@ -1,6 +1,5 @@
 #########################################################################
 #									#
-# File ID: ./.github/workflows/build-test.yml				#
 # Author: Copyright (C) 2021-2023  Mark Grant                           #
 #									#
 # Released under the GPLv3 only.					#
@@ -12,24 +11,6 @@
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 27/02/2021	MG	1.0.1	Initial release.                        #
-# 19/11/2021    MG      1.0.2   Get tags as needed for git-enhanced     #
-#                               AC_INIT.                                #
-# 21/11/2021    MG      1.0.3   Tighten SPDX tag.                       #
-# 13/10/2022    MG      1.0.4   Run on focal.                           #
-# 13/03/2023    MG      1.0.5   Run on ubuntu-latest.                   #
-# 01/08/2023    MG      1.0.6   Run on jammy.                           #
-#                               Delete txt2man install, rely on         #
-#                               dependencies.                           #
-#									#
-#########################################################################
-
 
 name: Build Test
 

diff --git a/Makefile.am b/Makefile.am
@@ -1,6 +1,5 @@
 #########################################################################
 #									#
-# Script ID: ./Makefile.am						#
 # Author: Copyright (C) 2014-2019, 2021, 2023  Mark Grant		#
 #									#
 # Released under the GPLv3 only.					#
@@ -11,46 +10,6 @@
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 25/06/2014	MG	1.0.1	Started versioning of this script.	#
-# 02/08/2014	MG	1.0.2	Change naming from AutoTools to		#
-#				AutoConf and Make.			#
-# 17/10/2015	MG	1.0.3	Restructure to conform to AutoTools	#
-#				General Template v1.0.5.		#
-# 01/12/2017	MG	1.0.4	Add SPDX license tags to source files.	#
-# 09/02/2018	MG	1.0.5	Shorten directory names to reduce	#
-#				overall path length.			#
-#				Add standard macro directory.		#
-# 07/04/2018	MG	1.0.6	Add srctarball target to build a source	#
-#				tarball in the build directory. Uses	#
-#				git archive to archive HEAD.		#
-# 09/06/2018	MG	1.0.7	Add info messages to srctarball target.	#
-# 27/10/2018	MG	1.0.8	Change srctarball target to build with	#
-#				src between package name and version in	#
-#				filename.				#
-# 16/03/2019	MG	1.0.9	Remove unnecessary shebang.		#
-#				Change source tarball name to be the	#
-#				same as that in GitHub releases. This	#
-#				aids integrating with rpm generation.	#
-#				Add install of standard GNU files like	#
-#				AUTHORS, etc.				#
-# 25/06/2019	MG	1.0.10	To enable make distcheck to work, any	#
-#				hard-coded paths requiring permissions	#
-#				such as /etc or fixed locations such as	#
-#				/usr/share/java must be accommodated,	#
-#				so set the configure flags to be used	#
-#				by make distcheck.			#
-# 08/11/2021	MG	1.0.11	Add misc directory to DIST.		#
-# 21/11/2021	MG	1.0.12	Tighten SPDX tag.			#
-# 01/08/2023	MG	1.0.13	Enable use of v1.1.1~rc1 type vesrion	#
-#									#
-#########################################################################
-
 
 ACLOCAL_AMFLAGS = -I m4
 

diff --git a/configure.ac b/configure.ac
@@ -1,6 +1,5 @@
 #########################################################################
 #									#
-# Script ID: ./configure.ac						#
 # Author: Copyright (C) 2014-2023  Mark Grant				#
 #									#
 # Released under the GPLv3 only.					#
@@ -26,7 +25,6 @@
 #	failing because it cannot be found.				#
 #									#
 # Layout: (Only relevant sections will exist).				#
-# ChangeLog : High level ChangeLog					#
 # SECTION  1: Initialisation & Setup					#
 # SECTION  2: Architecture, target and host checks			#
 # SECTION  3: Command line arguments					#
@@ -45,72 +43,6 @@
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 25/06/2014	MG	1.0.1	Started versioning of this script.	#
-# 26/06/2014	MG	1.0.2	Use 'git describe --always' for AC_INIT	#
-#				version as it returns a value as long	#
-#				as there is at least 1 commit, even	#
-#				with no tags. If no commits then	#
-#				'Pre-Release' is used.			#
-# 02/08/2014	MG	1.0.3	Change naming from AutoTools to		#
-#				AutoConf and Make.			#
-# 18/11/2014	MG	1.0.4	Re-structure to cope with OS		#
-#				differences. Add check for GNU getopt.	#
-# 24/11/2014	MG	1.0.5	Add support for passing overall package	#
-#				version to Makefiles.			#
-# 29/11/2014	MG	1.0.6	Remove redundant hashpling.		#
-# 26/06/2015	MG	1.0.7	Remove BSD support.			#
-# 27/09/2015	MG	1.0.8	Change to conform to AutoTools Template	#
-#				version 1.0.4.				#
-# 17/10/2015	MG	1.0.9	Restructure to conform to AutoTools	#
-#				General Template v1.0.5.		#
-# 25/02/2017	MG	1.0.10	Update sed edit substitution variable.	#
-# 28/04/2017	MG	1.0.11	Make AC_INIT and pkgversion AC_SUBST	#
-#				multi-line.				#
-# 01/12/2017	MG	1.0.12	Add SPDX license tags to source files.	#
-# 09/02/2018	MG	1.0.13	Shorten directory names to reduce	#
-#				overall path length.			#
-#				Update minimum AutoTools version.	#
-#				Standardise configure.ac and macro	#
-#				directory.				#
-#				Use automake sub-directory and tar	#
-#				Posix format directives.		#
-# 07/04/2018	MG	1.0.14	Change package versioning to use	#
-#				hard-coded value. This is due to the	#
-#				use of github which produces source	#
-#				tarballs which can be used for package	#
-#				generation. These tarballs are used	#
-#				outside of git so git versioning is not	#
-#				possible, hence the hard-coded value.	#
-#				Because of this, other packaging should	#
-#				probably use the source tarball rather	#
-#				than a dist tarball.			#
-# 22/03/2019	MG	1.1.1	Pass bash path to scripts and Makefiles	#
-#				Remove leading v from package version.	#
-#				Add --enable-testinghacks option.	#
-#				Re-vamp to new standard layout.		#
-# 25/06/2019	MG	1.1.2	Improve header comments on CLAs.	#
-# 28/06/2019	MG	1.1.3	Correct ARG_ENABLE help text.		#
-# 11/06/2020	MG	1.1.4	Tighten up program checks.		#
-# 19/11/2021	MG	1.1.5	If git is available and we are inside a	#
-#				git tree then use git describe to add	#
-#				further package version information.	#
-# 21/11/2021	MG	1.1.6	Tighten SPDX tag.			#
-#				Add AC_COPYRIGHT macro.			#
-# 09/10/2022	MG	1.1.7	Separate AutoTools generated files from	#
-#				project root.				#
-#				Use AC MSG CHECKING where appropriate.	#
-# 12/03/2023	MG	1.1.8	Update Copyright for 2023.		#
-#				Add run-time warning checks for clang,	#
-#				iwyu and scan-build.			#
-#									#
-#########################################################################
-
 
 #########################################
 #					#

diff --git a/m4/.gitignore b/m4/.gitignore
@@ -1,5 +1,20 @@
-# This .gitignore file is to ensure that this directory exists even if empty.
-# This is required because otherwise, after cloning, the project build will fail
-# citing this missing directory.
+#########################################################################
+#									#
+# Author: Copyright (C) 2023  Mark Grant				#
+#									#
+# Released under the GPLv3 only.					#
+# SPDX-License-Identifier: GPL-3.0-only					#
+#									#
+# N.B.									#
+# After changes to any gitignore file please run			#
+#		'git ls-files -i --exclude-standard'			#
+# to determine if any tracked files are now ignored.			#
+#									#
+#########################################################################
+
+# This .gitignore file is to ensure that this directory exists even though
+# none of it's contents will ever be tracked. This is required because
+# otherwise, after cloning, the project build will fail citing this missing
+# directory.
 # In other words, this is a git hack to satisfy AutoTools.
 
diff --git a/misc/TODO.txt b/misc/TODO.txt
@@ -1,22 +1,11 @@
 #########################################################################
 #									#
-# File ID: ./misc/TODO.txt						#
 # Author: Mark Grant							#
 #									#
 # Purpose:								#
 # Contains project-wide notes on work needing done.			#
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 03/12/2017	MG	1.0.1	Created.				#
-#									#
-#########################################################################
-
 
 Currently no Notes.
diff --git a/src/man/1/Makefile.am b/src/man/1/Makefile.am
@@ -1,7 +1,6 @@
 #########################################################################
 #									#
-# Script ID: src/man/1/Makefile.am					#
-# Author: Copyright (C) 2014-2019, 2021  Mark Grant			#
+# Author: Copyright (C) 2014-2019, 2021, 2023  Mark Grant		#
 #									#
 # Released under the GPLv3 only.					#
 # SPDX-License-Identifier: GPL-3.0-only					#
@@ -11,33 +10,6 @@
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 25/06/2014	MG	1.0.1	Started versioning of this script.	#
-# 02/08/2014	MG	1.0.2	Change naming from AutoTools to		#
-#				AutoConf and Make.			#
-# 27/09/2015	MG	1.0.3	Change to conform to AutoTools Template	#
-#				version 1.0.4.				#
-# 17/10/2015	MG	1.0.4	Restructure to conform to AutoTools	#
-#				General Template v1.0.5.		#
-# 28/04/2017	MG	1.0.5	Output from $(edit) was being ignored.	#
-#				Rename source file extension .man.in	#
-# 01/12/2017	MG	1.0.6	Add SPDX license tags to source files.	#
-#				Determine the manual section from the	#
-#				target suffix. If the suffix is blank	#
-#				(foo.) or if there is no suffix (foo)	#
-#				then error out.				#
-# 06/02/2018	MG	1.0.7	Update for new -g --gnulib option and	#
-#				name change to acmbuild.sh		#
-# 16/03/2019	MG	1.0.8	Remove unnecessary shebang.		#
-# 21/11/2021	MG	1.0.9	Tighten SPDX tag.			#
-#									#
-#########################################################################
-
 
 acmbuild.sh.1: Makefile
 	mkdir -p $(@D)

diff --git a/src/prg/bash/Makefile.am b/src/prg/bash/Makefile.am
@@ -1,7 +1,6 @@
 #########################################################################
 #									#
-# Script ID: src/prg/bash/Makefile.am					#
-# Author: Copyright (C) 2014-2019, 2021  Mark Grant			#
+# Author: Copyright (C) 2014-2019, 2021, 2023  Mark Grant		#
 #									#
 # Released under the GPLv3 only.					#
 # SPDX-License-Identifier: GPL-3.0-only					#
@@ -11,30 +10,6 @@
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 25/06/2014	MG	1.0.1	Started versioning of this script.	#
-# 02/08/2014	MG	1.0.2	Change naming from AutoTools to		#
-#				AutoConf and Make.			#
-# 24/11/2014	MG	1.0.3	Add script substitution variable for	#
-#				overall package version.		#
-# 27/09/2015	MG	1.0.4	Change to conform to AutoTools Template	#
-#				version 1.0.4.				#
-# 17/10/2015	MG	1.0.5	Restructure to conform to AutoTools	#
-#				General Template v1.0.5.		#
-# 28/04/2017	MG	1.0.6	Rename source file extension .sh.in	#
-# 01/12/2017	MG	1.0.7	Add SPDX license tags to source files.	#
-# 06/02/2018	MG	1.0.8	Add build of bootstrap.sh		#
-# 17/03/2019	MG	1.0.9	Remove unnecessary shebang.		#
-#				Install bootstrap.sh in pkglibexecdir.	#
-# 21/11/2021	MG	1.0.10	Tighten SPDX tag.			#
-#									#
-#########################################################################
-
 
 acmbuild.sh bootstrap.sh: Makefile
 	mkdir -p $(@D)

diff --git a/src/prg/bash/acmbuild.sh.in b/src/prg/bash/acmbuild.sh.in
@@ -8,7 +8,6 @@
 
 #########################################################################
 #									#
-# Script ID: acmbuild.sh						#
 # Author: Copyright (C) 2018-2019, 2021, 2023  Mark Grant		#
 #									#
 # Released under the GPLv3 only.					#
@@ -28,27 +27,6 @@
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 06/02/2018	MG	1.0.1	Created.				#
-# 23/12/2018	MG	1.0.2	Remove script_exit_code variable 	#
-#				propogating the exit code as a function	#
-#				argument instead.			#
-#				Improve trap exit code handling.	#
-#				Tidy up local and global variables.	#
-# 24/03/2019	MG	1.0.3	Replace #! env bash with absolute path	#
-#				via configure.				#
-#				bootstrap.sh is now in pkglibexecdir.	#
-#				Use scriptloc substitution variable to	#
-#				find bootstrap.sh (testing-hacks).	#
-# 21/11/2021	MG	1.0.4	Tighten SPDX tag.			#
-# 28/08/2023	MG	1.0.5	Fix shellcheck warnings.		#
-#									#
-#########################################################################
 
 ##################
 # Init variables #