all: Remove most in-file ChangeLogs and versioning

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 <[email protected]>
m-grant-prg · Oct 9, 2023 · 5aa529f · 5aa529f
1 parent 4b776c3
commit 5aa529f
Show file tree

Hide file tree

Showing 14 changed files with 21 additions and 373 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.                        #
-# 11/11/2021    MG      1.0.2   Get tags as needed for git-enhanced     #
-#                               AC_INIT.                                #
-# 22/11/2021    MG      1.0.3   Tighten SPDX tag.                       #
-# 14/10/2022    MG      1.0.4   Run on focal 20.04                      #
-# 29/03/2023    MG      1.0.5   Run on ubuntu-latest.                   #
-# 11/08/2023    MG      1.0.6   Run on jammy.                           #
-#                               Remove txt2man, rely on txt2manwrap     #
-#                               dependencies.                           #
-#									#
-#########################################################################
-
 
 name: Build Test
 

diff --git a/Makefile.am b/Makefile.am
@@ -1,6 +1,5 @@
 #########################################################################
 #									#
-# Script ID: ./Makefile.am						#
 # Author: Copyright (C) 2014-2021, 2023  Mark Grant			#
 #									#
 # Released under the GPLv3 only.					#
@@ -11,49 +10,6 @@
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 27/10/2014	MG	1.0.1	Started versioning of this script.	#
-# 28/09/2015	MG	1.0.2	Change to conform to AutoTools Template	#
-#				version 1.0.4.				#
-# 19/10/2015	MG	1.0.3	Restructure to conform to AutoTools	#
-#				General Template v1.0.5.		#
-# 28/04/2017	MG	1.0.4	Move man page to man section 8.		#
-# 01/12/2017	MG	1.0.5	Add SPDX license tags to source files.	#
-# 09/02/2018	MG	1.0.6	Shorten directory names to reduce	#
-#				overall path length.			#
-# 07/04/2018	MG	1.0.7	Add srctarball target to build a source	#
-#				tarball in the build directory. Uses	#
-#				git archive to archive HEAD.		#
-# 09/06/2018	MG	1.0.8	Add info messages to srctarball target.	#
-# 31/10/2018	MG	1.0.9	Change srctarball target to build with	#
-#				src between package name and version in	#
-#				filename.				#
-# 22/09/2019	MG	1.0.10	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.				#
-#				Remove shebang.				#
-#				Add standard AMFLAGS statement.		#
-#				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.			#
-# 21/05/2020	MG	1.0.11	Add sysconfdir and pkgdatadir support.	#
-# 08/11/2021	MG	1.0.12	Add misc directory to DIST.		#
-# 22/11/2021	MG	1.0.13	Tighten SPDX tag.			#
-# 26/06/2023	MG	1.0.14	Enable use of v1.1.1~rc1 type vesrion	#
-#				numbers for source tarballs.		#
-#									#
-#########################################################################
-
 
 ACLOCAL_AMFLAGS = -I m4
 

diff --git a/configure.ac b/configure.ac
@@ -1,19 +1,17 @@
 #########################################################################
 #									#
-# Script ID: ./configure.ac						#
 # Author: Copyright (C) 2014-2023  Mark Grant				#
 #									#
 # Released under the GPLv3 only.					#
 # SPDX-License-Identifier: GPL-3.0-only					#
 #									#
 # Purpose:								#
-# Autoconfigure script file to configure agmaint project.		#
+# Autoconf script file to configure agmaint project.			#
 #									#
-# configure cmd line syntax:-						#
-# ./configure								#
+# To get the configure cmd line syntax:-				#
+# ./configure --help							#
 #									#
 # 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					#
@@ -32,67 +30,6 @@
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 27/10/2014	MG	1.0.1	Started versioning of this script.	#
-# 18/11/2014	MG	1.0.2	Re-structure to cope with OS		#
-#				differences. Add check for GNU getopt.	#
-# 25/11/2014	MG	1.0.3	Add support for passing overall package	#
-#				version to Makefiles.			#
-# 29/11/2014	MG	1.0.4	Remove redundant hashpling.		#
-# 26/06/2015	MG	1.0.5	Remove BSD support.			#
-# 28/09/2015	MG	1.0.6	Change to conform to AutoTools Template	#
-#				version 1.0.4.				#
-# 19/10/2015	MG	1.0.7	Restructure to conform to AutoTools	#
-#				General Template v1.0.5.		#
-# 28/04/2017	MG	1.0.8	Move man page to man section 8.		#
-#				Make AC_INIT and pkgversion AC_SUBST	#
-#				multi-line.				#
-#				Fully populate sed variable		#
-#				substitution.				#
-# 01/12/2017	MG	1.0.9	Add SPDX license tags to source files.	#
-# 09/02/2018	MG	1.0.10	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.11	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/09/2019	MG	1.1.0	Re-vamp to new standard layout.		#
-#				Remove v from package version string.	#
-# 21/05/2020	MG	1.1.1	Make package tarname available for	#
-#				substitution.				#
-#				Add sysconfdir and pkgdatadir support.	#
-# 14/06/2020	MG	1.1.2	Correct program checks.			#
-# 14/03/2021	MG	1.1.3	Add wget check.				#
-# 25/04/2021	MG	1.1.4	Change wget to curl.			#
-# 11/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.	#
-# 22/11/2021	MG	1.1.6	Tighten SPDX tag.			#
-#				Add AC_COPYRIGHT macro.			#
-# 10/02/2022	MG	1.1.7	apt-key is deprecated so use gpg - add	#
-#				a program check.			#
-# 09/10/2022	MG	1.1.8	Separate AutoTools generated files from	#
-#				project root.				#
-# 29/03/2023	MG	1.1.9	Update Copyright for 2023.		#
-#									#
-#########################################################################
-
 
 #########################################
 #					#

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/data/pkgdata/trusted.sh.d/Makefile.am b/src/data/pkgdata/trusted.sh.d/Makefile.am
@@ -1,7 +1,6 @@
 #########################################################################
 #									#
-# Script ID: src/data/pkgdata/trusted.sh.d/Makefile.am			#
-# Author: Copyright (C) 2020-2022  Mark Grant				#
+# Author: Copyright (C) 2020-2023  Mark Grant				#
 #									#
 # Released under the GPLv3 only.					#
 # SPDX-License-Identifier: GPL-3.0-only					#
@@ -11,21 +10,6 @@
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 21/05/2020	MG	1.0.1	Created.				#
-# 13/03/2021	MG	1.0.2	Remove Bintray as it is stopping.	#
-# 22/11/2021	MG	1.0.3	Tighten SPDX tag.			#
-# 18/01/2022	MG	1.0.4	Remove OBS scripts. OBS keyring support	#
-# 				now provided by package			#
-# 				mgrant-obs-deb-keyring.			#
-#									#
-#########################################################################
-
 
 trustedscriptdir = $(pkgdatadir)/trusted.sh.d
 

diff --git a/src/data/pkgdata/trusted.sh.d/add-hermes.sh.in b/src/data/pkgdata/trusted.sh.d/add-hermes.sh.in
@@ -8,7 +8,6 @@
 
 #########################################################################
 #									#
-# Script ID: add-hermes.sh						#
 # Author: Copyright (C) 2020-2023  Mark Grant				#
 #									#
 # Released under the GPLv3 only.					#
@@ -19,9 +18,7 @@
 # directory. This is designed to be run via the apt-key-scripts.sh	#
 # script but can be run manually.					#
 #									#
-# Syntax:	add-hermes.sh	[ -h || --help ] ||			#
-#				[ -v || --verbose ] ||			#
-#				[ -V || --version ] 			#
+# Syntax:	See usage().						#
 #									#
 # Exit codes used:-							#
 # Bash standard Exit Codes:	0 - success				#
@@ -51,23 +48,6 @@
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 22/05/2020	MG	1.0.1	Created.				#
-# 14/03/2021	MG	1.0.2	Use hermes FQDN otherwise it does not	#
-#				work in Ubuntu containers.		#
-# 25/04/2021	MG	1.0.3	Prefer curl to wget.			#
-# 22/11/2021	MG	1.0.4	Tighten SPDX tag.			#
-# 10/02/2022	MG	1.0.5	apt-key is deprecated, use gpg.		#
-# 10/07/2023	MG	1.0.6	Fix shellcheck warnings.		#
-#				Add pipefail protection.		#
-#									#
-#########################################################################
-
 
 set -eo pipefail
 
@@ -88,9 +68,10 @@ verbose="q"
 # -h --help output.
 # No parameters
 # No return value
-usage ()
+usage()
 {
 cat << EOF
+Usage is $0 {-h|-v|-V}
 Usage is $0 [OPTIONS]
 	[OPTIONS] are:-
 	-h or --help Displays usage information

diff --git a/src/data/pkgdata/trusted.sh.d/add-mgrant-utils-ppa.sh.in b/src/data/pkgdata/trusted.sh.d/add-mgrant-utils-ppa.sh.in
@@ -8,7 +8,6 @@
 
 #########################################################################
 #									#
-# Script ID: add-mgrant-utils-ppa.sh					#
 # Author: Copyright (C) 2020-2023  Mark Grant				#
 #									#
 # Released under the GPLv3 only.					#
@@ -19,9 +18,7 @@
 # m-grant-prg utils PPA. This is designed to be run via the		#
 # apt-key-scripts.sh script but can be run manually.			#
 #									#
-# Syntax:	add-mgrant-utils-ppa.sh	[ -h || --help ] ||		#
-#					[ -v || --verbose ] ||		#
-#					[ -V || --version ] 		#
+# Syntax:	See usage().						#
 #									#
 # Exit codes used:-							#
 # Bash standard Exit Codes:	0 - success				#
@@ -51,20 +48,6 @@
 #									#
 #########################################################################
 
-#########################################################################
-#									#
-# Changelog								#
-#									#
-# Date		Author	Version	Description				#
-#									#
-# 22/05/2020	MG	1.0.1	Created.				#
-# 22/11/2021	MG	1.0.2	Tighten SPDX tag.			#
-# 10/02/2022	MG	1.0.3	apt-key is deprecated, use gpg.		#
-# 10/07/2023	MG	1.0.4	Fix shellcheck warnings.		#
-#				Add pipefail protection.		#
-#									#
-#########################################################################
-
 
 set -eo pipefail
 
@@ -83,9 +66,10 @@ readonly packageversion=@pkgversion@		# Package version
 # -h --help output.
 # No parameters
 # No return value
-usage ()
+usage()
 {
 cat << EOF
+Usage is $0 {-h|-v|-V}
 Usage is $0 [OPTIONS]
 	[OPTIONS] are:-
 	-h or --help Displays usage information