Updated Git, Coreutils and Emacs, new script to prepare tarballs

Until now, one had to follow the instructions from [1] to prepare a
standard software tarball before merging with the low-level
tarballs-software repository [2]. The script only worked for '.tar.gz'
suffix and was only available as a comment on Savannah (in [1]).

With this commit, the script has been imported into Maneage as
'reproduce/software/shell/tarball-prepare.sh' to simplify future software
updates. It work with all supported '.tar.*' suffixes (of the upstream
tarball repository) and will convert the tarballs to Maneage's standard
format. Also, this script has a minimal argument parser and can skip the
tarballs that are already unpacked, allowing faster tests.

This script was used to update the versions of:

    Coreutiles    9.0  --> 9.1
    Git           2.34 --> 2.36
    Emacs         27.2 --> 28.1

The main motive behind this update was Git which announced a vulnerability
issue [3] and suggested an update to the latest version as soon as
possible. More detail is described in this github blog [4], but in summary,
it was a security issue on multi-user systems that has been found and fixed
by Git developers. Since Maneage is often installed on such shared systems,
it was important to make this update. GNU Coreutils and GNU Emacs were also
updated because they are also commonly used.

The following improvements have also done with this commit:

 - .gitignore: ignore emacs auto-save files (that end with a '#')

 - README-hacking.md: In the checklist for updating the Maneage branch, the
   no-longer-necessary '--decorate' option of Git was removed from the
   command to check the general branch history.

[1] https://savannah.nongnu.org/task/?15699
[2] https://git.maneage.org/tarballs-software.git/
[3] https://lore.kernel.org/git/xmqqv8veb5i6.fsf@gitster.g/
[4] https://github.blog/2022-04-12-git-security-vulnerability-announced/

1 files changed, 181 insertions, 0 deletions

diff --git a/reproduce/software/shell/tarball-prepare.sh b/reproduce/software/shell/tarball-prepare.sh
new file mode 100755
index 0000000..ccc9318
--- /dev/null
+++ b/reproduce/software/shell/tarball-prepare.sh
@@ -0,0 +1,181 @@
+#!/bin/bash
+
+# Script to convert all files (tarballs in any format; just recognized
+# by 'tar') within an 'odir' to a unified '.tar.lz' format.
+#
+# The inputs are assumed to be formatted with 'NAME_VERSION', and only for
+# the names, we are currently assuming '.tar.*' (for the 'sed'
+# command). Please modify/generalize accordingly.
+#
+# It will unpack the source in a certain empty directory with the
+# 'tmpunpack' suffix, and rename the top directory to the requested format
+# of NAME-VERSION also. So irrespective of the name of the top original
+# tarball directory, the resulting tarball's top directory will have a name
+# formatting of NAME-VERSION.
+#
+# Discussion: https://savannah.nongnu.org/task/?15699
+#
+# Copyright (C) 2022 Mohammad Akhlaghi <mohammad@akhlaghi.org>
+# Copyright (C) 2022 Pedram Ashofteh Ardakani <pedramardakani@pm.me>
+# Released under GNU GPLv3+
+
+# Abort the script in case of an error.
+set -e
+
+
+
+
+
+# Default arguments
+odir=
+idir=
+quiet=
+basedir=$PWD
+
+
+# The --help output
+print_help() {
+    cat <<EOF
+Usage: $0 [OPTIONS]
+
+Low-level script to create maneage-standard tarballs.
+
+  -o, --output-dir         Target directory to write the packed tarballs.
+                           Current: $odir
+
+
+  -i, --input-dir          Directory containing original tarballs.
+                           Current: $idir
+
+  -q, --quiet              Suppress logging information. Only print the
+                           final packed file and its sha512sum.
+
+Maneage URL: https://maneage.org
+
+Report bugs: https://savannah.nongnu.org/bugs/?group=reproduce
+EOF
+}
+
+
+
+
+# Parse the arguments
+while [ $# -gt 0 ]
+do
+  case $1 in
+      -q|--quiet)      quiet=1; shift;;
+      -h|--help|-'?')  print_help; exit 0;;
+      -i|--input-dir)
+          # Remove the trailing '/' introduced by autocomplete
+          idir=$(echo "$2" | sed 's|/$||');
+          shift;  # past argument
+          shift;; # past value
+      -o|--output-dir)
+          # Remove the trailing '/' introduced by autocomplete
+          odir=$(echo "$2" | sed 's|/$||');
+          shift;  # past argument
+          shift;; # past value
+      *)  echo "$0: unknown option '$1'"; exit 1;;
+  esac
+done
+
+
+
+
+# Extract the 'absolute path' to input and output directories. Working with
+# relative path is a great source of confusion and unwanted side-effects
+# like moving/removing files by accident.
+if [ ! -d "$idir" ]; then
+    echo "$0: please pass the input directory (option --input-dir or -i)."
+    exit 1
+else
+    idir=$(realpath $idir)
+fi
+
+if [ ! -d "$odir" ]; then
+    echo "$0: please pass the output directory (option --output-dir or -o)."
+    exit 1
+else
+    odir=$(realpath $odir)
+fi
+
+
+
+
+
+# Unpack and pack all files in the '$idir'
+# ----------------------------------------
+allfiles=$(ls $idir | sort)
+
+# Let user know number of tarballs if its not in quiet mode
+if [ -z $quiet ]; then
+    nfiles=$(ls $idir | wc -l)
+    echo "Found $nfiles file(s) in '$idir/'"
+fi
+
+# Process all files
+for f in $allfiles; do
+
+    # Seperate name and version number
+    name=$(echo $f | sed -e 's/.tar.*//' | \
+                     awk 'BEGIN { FS = "[-_ ]" } {print $1 "-" $2}')
+
+    # Skip previously packed files
+    if [ -f $odir/$name.tar.lz ]; then
+
+        # Print the info message if not in quiet mode
+        if [ -z $quiet ]; then
+            echo "$0: skipping '$odir/$name.tar.lz'"
+        fi
+
+        # skip this file
+        continue
+    else
+
+        # Print the info message if not in quiet mode
+        if [ -z $quiet ]; then
+            echo "$0: processing '$idir/$f'"
+        fi
+    fi
+
+    # Create a temporary directory name
+    tmpdir=$odir/$name-tmpunpack
+
+    # If the temporary directory exists, mkdir will throw an error. The
+    # developer needs to intervene manually to fix the issue.
+    mkdir $tmpdir
+
+
+
+
+
+    # Move into the temporary directory
+    # ---------------------------------
+    #
+    # The default output directory for all the following commands: $tmpdir
+    cd $tmpdir
+
+    # Unpack
+    tar -xf $idir/$f
+
+    # Make sure the unpacked tarball is contained within a directory with
+    # the clean program name
+    if [ ! -d "$name" ]; then
+        mv * $name/
+    fi
+
+    # Pack with recommended options
+    tar -c -Hustar --owner=root --group=root \
+        -f $name.tar $name/
+    lzip -9 $name.tar
+
+    # Move the compressed file from the temporary directory to the target
+    # output directory
+    mv $name.tar.lz $odir/
+
+    # Print the sha512sum along with the filename for a quick reference
+    echo $(sha512sum $odir/$name.tar.lz)
+
+    # Clean up the temporary directory
+    rm -r $tmpdir
+done