Merge branch 'version-full-progress' into 'master'

feat(version): enhance version check spinner to progressively update the full pretty output

See merge request archlinux/devtools!313

Makefile

@@ -1,6 +1,6 @@
 SHELL=/bin/bash -o pipefail
 
-V=1.3.2
+V=1.4.0
 BUILDTOOLVER ?= $(V)
 
 PREFIX = /usr/local
@@ -19,6 +19,7 @@ PACMAN_CONFIGS=$(wildcard config/pacman/*)
 GIT_CONFIGS = $(wildcard config/git/*)
 SETARCH_ALIASES = $(wildcard config/setarch-aliases.d/*)
 MANS = $(addprefix $(BUILDDIR)/,$(patsubst %.asciidoc,%,$(wildcard doc/man/*.asciidoc)))
+DATA_FILES = $(wildcard data/*)
 
 COMMITPKG_LINKS = \
 	core-testingpkg \
@@ -59,7 +60,7 @@ BATS_ARGS ?= --jobs $(JOBS) $(BATS_EXTRA_ARGS) --verbose-run
 COVERAGE_DIR ?= $(BUILDDIR)/coverage
 
 
-all: binprogs library conf completion man
+all: binprogs library conf completion man data
 binprogs: $(BINPROGS)
 library: $(LIBRARY)
 completion: $(COMPLETIONS)
@@ -112,6 +113,10 @@ conf:
 	@install -d $(BUILDDIR)/git.conf.d
 	@cp -a $(GIT_CONFIGS) $(BUILDDIR)/git.conf.d
 
+data:
+	@install -d $(BUILDDIR)/data
+	@cp -ra $(DATA_FILES) $(BUILDDIR)/data
+
 clean:
 	rm -rf $(BUILDDIR)
 
@@ -122,9 +127,11 @@ install: all
 	install -dm0755 $(DESTDIR)$(DATADIR)/pacman.conf.d
 	install -m0755 ${BINPROGS} $(DESTDIR)$(PREFIX)/bin
 	install -dm0755 $(DESTDIR)$(DATADIR)/lib
+	install -dm0755 $(DESTDIR)$(DATADIR)/data
 	cp -ra $(BUILDDIR)/lib/* $(DESTDIR)$(DATADIR)/lib
 	cp -a $(BUILDDIR)/git.conf.d -t $(DESTDIR)$(DATADIR)
 	cp -ra $(BUILDDIR)/makepkg.conf.d -t $(DESTDIR)$(DATADIR)
+	cp -ra $(BUILDDIR)/data -t $(DESTDIR)$(DATADIR)
 	for conf in $(notdir $(PACMAN_CONFIGS)); do install -Dm0644 $(BUILDDIR)/pacman.conf.d/$$conf $(DESTDIR)$(DATADIR)/pacman.conf.d/$${conf##*/}; done
 	for a in ${SETARCH_ALIASES}; do install -m0644 $$a -t $(DESTDIR)$(DATADIR)/setarch-aliases.d; done
 	for l in ${COMMITPKG_LINKS}; do ln -sf commitpkg $(DESTDIR)$(PREFIX)/bin/$$l; done
@@ -143,6 +150,7 @@ uninstall:
 	rm -rf $(DESTDIR)$(DATADIR)/lib
 	rm -rf $(DESTDIR)$(DATADIR)/git.conf.d
 	rm -rf $(DESTDIR)$(DATADIR)/makepkg.conf.d
+	rm -rf $(DESTDIR)$(DATADIR)/data
 	for conf in $(notdir $(PACMAN_CONFIGS)); do rm -f $(DESTDIR)$(DATADIR)/pacman.conf.d/$${conf##*/}; done
 	for f in $(notdir $(SETARCH_ALIASES)); do rm -f $(DESTDIR)$(DATADIR)/setarch-aliases.d/$$f; done
 	for l in ${COMMITPKG_LINKS}; do rm -f $(DESTDIR)$(PREFIX)/bin/$$l; done
@@ -186,5 +194,5 @@ coverage: binprogs library conf completion man
 check: $(BINPROGS_SRC) $(LIBRARY_SRC) contrib/completion/bash/devtools.in config/makepkg/x86_64.conf contrib/makepkg/PKGBUILD.proto
 	shellcheck $^
 
-.PHONY: all binprogs library completion conf man clean install uninstall tag dist upload test coverage check
+.PHONY: all binprogs library completion conf man data clean install uninstall tag dist upload test coverage check
 .DELETE_ON_ERROR:

README.md

@@ -94,6 +94,7 @@ Component: pkgctl db remove
 
 - bat (pretty printing)
 - nvchecker (version checking)
+- reuse (license compliance)
 
 ### Development Dependencies
 

config/git/template/info/exclude

@@ -2,6 +2,7 @@
 /src
 /*/
 !/keys/
+!/LICENSES/
 
 /*.log
 /*.tar.*

config/makepkg/conf.d/fortran.conf

@@ -1,4 +1,6 @@
 #!/hint/bash
+# shellcheck disable=2034
+
 #
 # /etc/makepkg.conf.d/fortran.conf
 #
@@ -9,10 +11,12 @@
 
 # Flags used for the Fortran compiler, similar in spirit to CFLAGS. Read
 # linkman:gfortran[1] for more details on the available flags.
-#FFLAGS="-O2 -pipe"
+FFLAGS="-march=x86-64 -mtune=generic -O2 -pipe -fno-plt \
-#FCFLAGS="$FFLAGS"
+        -Wp,-D_FORTIFY_SOURCE=3 -fstack-clash-protection -fcf-protection \
+        -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer"
+FCFLAGS="$FFLAGS"
 
 # Additional compiler flags appended to `FFLAGS` and `FCFLAGS` for use in debugging. Usually
 # this would include: ``-g''. Read linkman:gfortran[1] for more details on the wide
 # variety of compiler flags available.
-#DEBUG_FFLAGS="-g"
+DEBUG_FFLAGS="-g"

contrib/completion/bash/devtools.in

@@ -150,6 +150,7 @@ _pkgctl_cmds=(
 	db
 	diff
 	issue
+	license
 	release
 	repo
 	search
@@ -305,7 +306,6 @@ _pkgctl_repo_cmds=(
 	clone
 	configure
 	create
-	pull
 	switch
 	web
 )
@@ -335,19 +335,6 @@ _pkgctl_repo_clean_args=(
 )
 _pkgctl_repo_clean_opts() { _filedir -d; }
 
-_pkgctl_repo_pull_args=(
-	--discard-changes
-	--show-diff
-	--quiet
-	--autostash
-	-f --force
-	-j --jobs
-	-h --help
-)
-_pkgctl_repo_pull_args__jobs_opts() { :; }
-_pkgctl_repo_pull_args_j_opts() { _pkgctl_repo_pull_args__jobs_opts; }
-_pkgctl_repo_pull_opts() { _filedir -d; }
-
 _pkgctl_repo_configure_args=(
 	--protocol
 	-j --jobs
@@ -381,6 +368,25 @@ _pkgctl_repo_switch_opts() {
 	fi
 }
 
+_pkgctl_license_cmds=(
+	check
+	setup
+)
+
+_pkgctl_license_check_args=(
+	-h --help
+)
+
+_pkgctl_license_check_opts() { _filedir -d; }
+
+_pkgctl_license_setup_args=(
+	--no-check
+	-f --force
+	-h --help
+)
+
+_pkgctl_license_setup_opts() { _filedir -d; }
+
 _pkgctl_version_cmds=(
 	check
 	setup

contrib/completion/zsh/_devtools.in

@@ -61,7 +61,7 @@ _pkgctl_build_args=(
 	'--update-checksums[Force computation and update of the checksums (disables auto-detection)]'
 	'(-e --edit)'{-e,--edit}'[Edit the PKGBUILD before building]'
 	'(-r --release)'{-r,--release}'[Automatically commit, tag and release after building]'
-	'(-m --message=)'{-m,--message=}"[Use the given <msg> as the commit message]:message:"
+	'(-m --message)'{-m,--message}"[Use the given <msg> as the commit message]:message:"
 	'(-u --db-update)'{-u,--db-update}'[Automatically update the pacman database as last action]'
 	'(-h --help)'{-h,--help}'[Display usage]'
 	'*:git_dir:_files -/'
@@ -201,7 +201,7 @@ _pkgctl_issue_view_args=(
 )
 
 _pkgctl_release_args=(
-	'(-m --message=)'{-m,--message=}"[Use the given <msg> as the commit message]:message:"
+	'(-m --message)'{-m,--message}"[Use the given <msg> as the commit message]:message:"
 	'(-r --repo)'{-r,--repo}"[Specify a target repository for new packages]:repo:($DEVTOOLS_VALID_REPOS[*])"
 	'(-s --staging)'{-s,--staging}'[Release to the staging counterpart of the auto-detected repo]'
 	'(-t --testing)'{-t,--testing}'[Release to the testing counterpart of the auto-detected repo]'
@@ -228,7 +228,6 @@ _pkgctl_repo_cmds=(
 	"clone[Clone a package repository]"
 	"configure[Configure a clone according to distro specs]"
 	"create[Create a new GitLab package repository]"
-	"pull[Update package repositories from their git remote]"
 	"switch[Switch a package repository to a specified version]"
 	"web[Open the packaging repository's website]"
 )
@@ -257,17 +256,6 @@ _pkgctl_repo_clone_args=(
 	'*:packages:_devtools_completions_all_packages'
 )
 
-_pkgctl_repo_pull_args=(
-	'--discard-changes[Discard changes if index or working tree is dirty]'
-	'--quiet[Disable printing longer terminal output]'
-	'--show-diff[Always enable showing the diff]'
-	'--autostash[Stash before pulling and unstash afterwards]'
-	'(-f --force)'{-f,--force}'[Alias for --discard-changes]'
-	'(-j --jobs)'{-j,--jobs}'[Run up to N jobs in parallel (default: number of processing units)]:jobs:'
-	'(-h --help)'{-h,--help}'[Display usage]'
-	'*:git_dir:_files -/'
-)
-
 _pkgctl_repo_configure_args=(
 	'--protocol[Configure remote url to use https]:proto:(https)'
 	'(-j --jobs)'{-j,--jobs}'[Run up to N jobs in parallel (default: number of processing units)]:jobs:'
@@ -411,6 +399,7 @@ _pkgctl_cmds=(
 	"db[Pacman database modification for package update, move etc]"
 	"diff[Compare package files using different modes]"
 	"issue[Work with GitLab packaging issues]"
+	"license[Check and manage package license compliance]"
 	"release[Release step to commit, tag and upload build artifacts]"
 	"repo[Manage Git packaging repositories and their configuration]"
 	"search[Search for an expression across the GitLab packaging group]"
@@ -422,6 +411,24 @@ _pkgctl_args=(
 	'(-h --help)'{-h,--help}'[Display usage]'
 )
 
+_pkgctl_license_cmds=(
+	"pkgctl license command"
+	"check[Checks package licensing compliance using REUSE]"
+	"setup[Automatically detect and setup a basic REUSE config]"
+)
+
+_pkgctl_license_check_args=(
+	'(-h --help)'{-h,--help}'[Display usage]'
+	'*:git_dir:_files -/'
+)
+
+_pkgctl_license_setup_args=(
+	'(-f --force)'{-f,--force}'[Overwrite existing REUSE config]'
+	'--no-check[Do not run license check after setup]'
+	'(-h --help)'{-h,--help}'[Display usage]'
+	'*:git_dir:_files -/'
+)
+
 _pkgctl_version_cmds=(
 	"pkgctl version command"
 	"check[Compares local package versions against upstream versions]"

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright Arch Linux Contributors
+
+Permission to use, copy, modify, and/or distribute this software for
+any purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE
+FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY
+DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
+AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

doc/man/pkgctl-license-check.1.asciidoc

@@ -0,0 +1,54 @@
+pkgctl-license-check(1)
+=======================
+
+Name
+----
+pkgctl-license-check - Checks package licensing compliance using REUSE
+
+Synopsis
+--------
+pkgctl license check [OPTIONS] [PKGBASE...]
+
+Description
+-----------
+
+Checks package licensing compliance using REUSE and also verifies whether
+a LICENSE file with the expected Arch Linux-specific 0BSD license text exists.
+
+Configuration
+-------------
+
+Uses reuse(1) and a `REUSE.toml` file located alongside the PKGBUILD(5). Refer
+to the configuration section in pkgctl-license(1).
+
+If no `PKGBASE` is specified, the command defaults to using the current working
+directory.
+
+Options
+-------
+
+*-h, --help*::
+	Show a help text
+
+Exit Codes
+----------
+
+On exit, return one of the following codes:
+
+*0*::
+	Normal exit condition, all checked packages are compliant
+
+*1*::
+	Unknown cause of failure
+
+*2*::
+	Normal exit condition, but some packages are not compliant
+
+See Also
+--------
+
+pkgctl-license(1)
+reuse(1)
+PKGBUILD(5)
+
+include::include/footer.asciidoc[]

doc/man/pkgctl-license-setup.1.asciidoc

@@ -0,0 +1,55 @@
+pkgctl-license-setup(1)
+=======================
+
+Name
+----
+pkgctl-license-setup - Automatically detect and setup a basic REUSE
+configuration
+
+Synopsis
+--------
+pkgctl license setup [OPTIONS] [PKGBASE...]
+
+Description
+-----------
+
+This subcommand automates the creation of the Arch Linux 0BSD package license
+file as well as a basic reuse(1) configuration by applying simple heuristics.
+It comes in especially handy when initially setting up licensing for a package
+without the need to manually write a `REUSE.toml` file.
+
+If any `.patch` files are detected and the PKGBUILD(5) has only a single entry
+in the `license=()` array, this subcommand assumes the patches are licensed
+under that license and generates annotations for them.
+
+In case there are no patches, no additional annotations are generated.
+
+Manual annotations are necessary in case the subcommand can't generate a
+configuration that accounts for all files. In this case, `reuse lint` will fail
+with a descriptive error of which files are missing an annotation.
+
+If no `PKGBASE` is specified, the command defaults to using the current working
+directory.
+
+Options
+-------
+
+*-f, --force*::
+	Overwrite existing reuse(1) configuration
+
+*--no-check*::
+	Do not run pkgctl-license-check(1) after setup
+
+*-h, --help*::
+	Show a help text
+
+
+See Also
+--------
+
+pkgctl-license(1)
+pkgctl-license-check(1)
+reuse(1)
+PKGBUILD(5)
+
+include::include/footer.asciidoc[]

doc/man/pkgctl-license.1.asciidoc

@@ -0,0 +1,54 @@
+pkgctl-license(1)
+=================
+
+Name
+----
+pkgctl-license - Check and manage package license compliance
+
+Synopsis
+--------
+pkgctl license [OPTIONS] [SUBCOMMAND]
+
+Description
+-----------
+
+Commands related to package licenses, including checks for compliance.
+
+Uses reuse(1) and a `REUSE.toml` file located alongside the PKGBUILD(5).
+
+Configuration
+-------------
+
+The `REUSE.toml` file must contain annotations for all regular files expected
+to be present in an Arch Linux package repository.
+
+Use pkgctl-license-setup(1) to automatically detect and setup a basic REUSE
+config file based on the files in the package repository.
+
+For detailed information on the various configuration options available for the
+`REUSE.toml` file, refer to the REUSE Specification (https://reuse.software/spec).
+
+Options
+-------
+
+*-h, --help*::
+	Show a help text
+
+Subcommands
+-----------
+
+pkgctl license check::
+	Checks package licensing compliance using REUSE
+
+pkgctl license setup::
+	Automatically detect and setup a basic REUSE config
+
+See Also
+--------
+
+pkgctl-license-check(1)
+pkgctl-license-setup(1)
+reuse(1)
+PKGBUILD(5)
+
+include::include/footer.asciidoc[]

doc/man/pkgctl-repo-pull.1.asciidoc

@@ -1,50 +0,0 @@
-pkgctl-repo-pull(1)
-===================
-
-Name
-----
-pkgctl-repo-pull - Pull in git changes
-
-Synopsis
---------
-pkgctl repo pull [OPTIONS] [PATH...]
-
-Description
------------
-
-Update package repositories from their git remotes.
-
-If only a single package is given the command also automatically shows a diff
-of what has changed since the last time the repository was updated.
-
-Options
--------
-
-*--discard-changes*::
-	Discard changes if the index or working tree was modified. Otherwise abort
-	if anything was modified.
-
-*--autostash*::
-	Stash before pulling and unstash afterwards
-
-*--quiet*::
-	Do not show any longer terminal output like diffs.
-
-*--show-diff*::
-	Show what has changed since the last time the repository was updated. Is
-	automatically set when only one 'PATH' is given.
-
-*-j, --jobs* 'N'::
-	Run up to N jobs in parallel. By default the number of jobs is equal to the
-	number of available processing units. For sequential processing this option
-	needs to be passed with 1.
-
-*-h, --help*::
-	Show a help text
-
-See Also
---------
-
-git-pull(1)
-
-include::include/footer.asciidoc[]

doc/man/pkgctl-repo.1.asciidoc

@@ -44,9 +44,6 @@ pkgctl repo configure::
 pkgctl repo create::
 	Create a new GitLab package repository
 
-pkgctl repo pull::
-	Update package repositories from their git remotes
-
 pkgctl repo switch::
 	Switch a package repository to a specified version
 
@@ -60,7 +57,6 @@ pkgctl-repo-clean(1)
 pkgctl-repo-clone(1)
 pkgctl-repo-configure(1)
 pkgctl-repo-create(1)
-pkgctl-repo-pull(1)
 pkgctl-repo-switch(1)
 pkgctl-repo-web(1)
 

src/commitpkg.in

@@ -120,8 +120,20 @@ if (( ${#validpgpkeys[@]} != 0 )); then
 	git add --force -- keys/pgp/*
 fi
 
+needsversioning=()
+
+if [[ ! -e REUSE.toml || ! -e LICENSE || ! -d LICENSES ]]; then
+	# TODO: Make this a hard failure in the future after packagers have had
+	# some time to add licenses to all packages.
+	warning "package doesn't have proper licensing information, set it up using:"
+	msg2 'pkgctl license setup'
+else
+	pkgctl license check
+	needsversioning+=(REUSE.toml LICENSE LICENSES/*)
+fi
+
 # find files which should be under source control
-needsversioning=(PKGBUILD)
+needsversioning+=(PKGBUILD)
 for s in "${source[@]}"; do
 	[[ $s != *://* ]] && needsversioning+=("$s")
 done
@@ -143,7 +155,7 @@ if (( ${#needsversioning[*]} )); then
 		if [[ ! -f "${file}" ]]; then
 			continue
 		fi
-		if ! git ls-files --error-unmatch "$file"; then
+		if ! git ls-files --error-unmatch "$file" >/dev/null; then
 			die "%s is not under version control" "$file"
 		fi
 	done

src/lib/build/build.sh

@@ -42,10 +42,10 @@ pkgctl_build_usage() {
 
 		Build packages inside a clean chroot
 
-		When a new pkgver is set using the appropriate PKGBUILD options the
+		Build packages in clean chroot environment, offering various options
-		checksums are automatically updated.
+		and functionalities to customize the package building process.
 
-		TODO
+		By default, chroot environments are located in /var/lib/archbuild/.
 
 		BUILD OPTIONS
 		    --arch ARCH          Specify architectures to build for (disables auto-detection)

src/lib/common.sh

@@ -18,6 +18,9 @@ export LANG=C.UTF-8
 # Avoid systemd trying to color the terminal on systemd-nspawn
 export SYSTEMD_TINT_BACKGROUND=no
 
+# Avoid diffoscope looking at remote debug info through readelf
+unset DEBUGINFOD_URLS
+
 # Set buildtool properties
 export BUILDTOOL=devtools
 export BUILDTOOLVER=@buildtoolver@

src/lib/license.sh

@@ -0,0 +1,66 @@
+#!/hint/bash
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+[[ -z ${DEVTOOLS_INCLUDE_LICENSE_SH:-} ]] || return 0
+DEVTOOLS_INCLUDE_LICENSE_SH=1
+
+_DEVTOOLS_LIBRARY_DIR=${_DEVTOOLS_LIBRARY_DIR:-@pkgdatadir@}
+
+set -e
+
+
+pkgctl_license_usage() {
+	local -r COMMAND=${_DEVTOOLS_COMMAND:-${BASH_SOURCE[0]##*/}}
+    cat <<- _EOF_
+		Usage: ${COMMAND} [COMMAND] [OPTIONS]
+
+		Check and manage package license compliance.
+
+		COMMANDS
+		    check      Check package license compliance
+		    setup      Automatically detect and setup a basic REUSE config
+
+		OPTIONS
+		    -h, --help    Show this help text
+
+		EXAMPLES
+		    $ ${COMMAND} check libfoo linux libbar
+		    $ ${COMMAND} setup libfoo
+_EOF_
+}
+
+pkgctl_license() {
+	if (( $# < 1 )); then
+		pkgctl_license_usage
+		exit 0
+	fi
+
+	while (( $# )); do
+		case $1 in
+			-h|--help)
+				pkgctl_license_usage
+				exit 0
+				;;
+			check)
+				_DEVTOOLS_COMMAND+=" $1"
+				shift
+				# shellcheck source=src/lib/license/check.sh
+				source "${_DEVTOOLS_LIBRARY_DIR}"/lib/license/check.sh
+				pkgctl_license_check "$@"
+				exit $?
+				;;
+			setup)
+				_DEVTOOLS_COMMAND+=" $1"
+				shift
+				# shellcheck source=src/lib/license/setup.sh
+				source "${_DEVTOOLS_LIBRARY_DIR}"/lib/license/setup.sh
+				pkgctl_license_setup "$@"
+				exit 0
+				;;
+			*)
+				die "invalid argument: %s" "$1"
+				;;
+		esac
+	done
+}

src/lib/license/check.sh

@@ -0,0 +1,147 @@
+#!/bin/bash
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+[[ -z ${DEVTOOLS_INCLUDE_LICENSE_CHECK_SH:-} ]] || return 0
+DEVTOOLS_INCLUDE_LICENSE_CHECK_SH=1
+
+_DEVTOOLS_LIBRARY_DIR=${_DEVTOOLS_LIBRARY_DIR:-@pkgdatadir@}
+# shellcheck source=src/lib/common.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/common.sh
+
+source /usr/share/makepkg/util/message.sh
+
+set -eo pipefail
+
+readonly PKGCTL_LICENSE_CHECK_EXIT_COMPLIANT=0
+export PKGCTL_LICENSE_CHECK_EXIT_COMPLIANT
+readonly PKGCTL_LICENSE_CHECK_EXIT_FAILURE=2
+export PKGCTL_LICENSE_CHECK_EXIT_FAILURE
+
+
+pkgctl_license_check_usage() {
+	local -r COMMAND=${_DEVTOOLS_COMMAND:-${BASH_SOURCE[0]##*/}}
+	cat <<- _EOF_
+		Usage: ${COMMAND} [OPTIONS] [PKGBASE]...
+
+		Checks package licensing compliance using REUSE and also verifies
+		whether a LICENSE file with the expected Arch Linux-specific 0BSD
+		license text exists.
+
+		Upon execution, it runs 'reuse lint'.
+
+		OPTIONS
+		    -h, --help   Show this help text
+
+		EXAMPLES
+		    $ ${COMMAND} neovim vim
+_EOF_
+}
+
+pkgctl_license_check() {
+	local pkgbases=()
+	local verbose=0
+
+	local license_text
+	license_text=$(< "${_DEVTOOLS_LIBRARY_DIR}"/data/LICENSE)
+
+	local exit_code=${PKGCTL_LICENSE_CHECK_EXIT_COMPLIANT}
+
+	while (( $# )); do
+		case $1 in
+			-h|--help)
+				pkgctl_license_check_usage
+				exit 0
+				;;
+			--)
+				shift
+				break
+				;;
+			-*)
+				die "invalid argument: %s" "$1"
+				;;
+			*)
+				pkgbases=("$@")
+				break
+				;;
+		esac
+	done
+
+	if ! command -v reuse &>/dev/null; then
+		die "The \"$_DEVTOOLS_COMMAND\" command requires the 'reuse' CLI tool"
+	fi
+
+	# Check if used without pkgbases in a packaging directory
+	if (( ${#pkgbases[@]} == 0 )); then
+		if [[ -f PKGBUILD ]]; then
+			pkgbases=(".")
+		else
+			pkgctl_license_check_usage
+			exit 1
+		fi
+	fi
+
+	# enable verbose mode when we only have a single item to check
+	if (( ${#pkgbases[@]} == 1 )); then
+		verbose=1
+	fi
+
+	for path in "${pkgbases[@]}"; do
+		# skip paths that are not directories
+		if [[ ! -d "${path}" ]]; then
+			continue
+		fi
+		pushd "${path}" >/dev/null
+
+		if [[ ! -f PKGBUILD ]]; then
+			msg_error "${BOLD}${pkgbase}:${ALL_OFF} no PKGBUILD found"
+			return 1
+		fi
+
+		# reset common PKGBUILD variables
+		unset pkgbase
+
+		# shellcheck source=contrib/makepkg/PKGBUILD.proto
+		if ! . ./PKGBUILD; then
+			msg_error "${BOLD}${pkgbase}:${ALL_OFF} failed to source PKGBUILD"
+			return 1
+		fi
+		pkgbase=${pkgbase:-$pkgname}
+
+		if [[ ! -e LICENSE ]]; then
+			msg_error "${BOLD}${pkgbase}:${ALL_OFF} is missing the LICENSE file"
+			return "${PKGCTL_LICENSE_CHECK_EXIT_FAILURE}"
+		fi
+
+		if [[ ! -L LICENSES/0BSD.txt ]]; then
+			msg_error "${BOLD}${pkgbase}:${ALL_OFF} LICENSES/0BSD should be a symlink to LICENSE but it isn't"
+			return "${PKGCTL_LICENSE_CHECK_EXIT_FAILURE}"
+		fi
+
+		# Check if the local LICENSE file mismatches our expectations
+		if [[ $license_text != $(< LICENSE) ]]; then
+			msg_error "${BOLD}${pkgbase}:${ALL_OFF} LICENSE file doesn't have the expected Arch Linux-specific license text"
+			return "${PKGCTL_LICENSE_CHECK_EXIT_FAILURE}"
+		fi
+
+		# Check for REUSE compliance
+		if ! reuse lint --json | jq --exit-status '.summary.compliant' &>/dev/null; then
+			msg_error "${BOLD}${pkgbase}:${ALL_OFF} repository is not REUSE compliant"
+			exit_code=${PKGCTL_LICENSE_CHECK_EXIT_FAILURE}
+
+			# re-execute reuse lint for human readable output
+			if (( verbose )); then
+				reuse lint
+			fi
+
+			popd >/dev/null
+			continue
+		fi
+
+		msg_success "${BOLD}${pkgbase}:${ALL_OFF} repository is REUSE compliant"
+		popd >/dev/null
+	done
+
+	# return status based on results
+	return "${exit_code}"
+}

src/lib/license/setup.sh

@@ -0,0 +1,272 @@
+#!/bin/bash
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+[[ -z ${DEVTOOLS_INCLUDE_LICENSE_SETUP_SH:-} ]] || return 0
+DEVTOOLS_INCLUDE_LICENSE_SETUP_SH=1
+
+_DEVTOOLS_LIBRARY_DIR=${_DEVTOOLS_LIBRARY_DIR:-@pkgdatadir@}
+# shellcheck source=src/lib/common.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/common.sh
+# shellcheck source=src/lib/license/check.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/license/check.sh
+
+source /usr/share/makepkg/util/message.sh
+
+set -eo pipefail
+shopt -s nullglob
+
+
+pkgctl_license_setup_usage() {
+	local -r COMMAND=${_DEVTOOLS_COMMAND:-${BASH_SOURCE[0]##*/}}
+	cat <<- _EOF_
+		Usage: ${COMMAND} [OPTIONS] [PKGBASE]...
+
+		Automate the creation of a basic REUSE configuration by analyzing the
+		license array specified in the PKGBUILD file of a package.
+
+		If no PKGBASE is specified, the command defaults to using the current
+		working directory.
+
+		OPTIONS
+		    -f, --force   Overwrite existing REUSE configuration
+		    -h, --help    Show this help text
+		    --no-check    Do not run license check after setup
+
+		EXAMPLES
+		    $ ${COMMAND} neovim vim
+_EOF_
+}
+
+pkgctl_license_setup() {
+	local pkgbases=()
+	local force=0
+	local run_check=1
+
+	local path exit_code
+	local checks=()
+
+	while (( $# )); do
+		case $1 in
+			-h|--help)
+				pkgctl_license_setup_usage
+				exit 0
+				;;
+			-f|--force)
+				force=1
+				shift
+				;;
+			--no-check)
+				run_check=0
+				shift
+				;;
+			--)
+				shift
+				break
+				;;
+			-*)
+				die "invalid argument: %s" "$1"
+				;;
+			*)
+				pkgbases=("$@")
+				break
+				;;
+		esac
+	done
+
+	if ! command -v reuse &>/dev/null; then
+		die "The \"$_DEVTOOLS_COMMAND\" command requires the 'reuse' CLI tool"
+	fi
+
+	# Check if used without pkgbases in a packaging directory
+	if (( ${#pkgbases[@]} == 0 )); then
+		if [[ -f PKGBUILD ]]; then
+			pkgbases=(".")
+		else
+			pkgctl_license_setup_usage
+			exit 1
+		fi
+	fi
+
+	exit_code=0
+	for path in "${pkgbases[@]}"; do
+		# skip paths that are not directories
+		if [[ ! -d "${path}" ]]; then
+			continue
+		fi
+
+		pushd "${path}" >/dev/null
+		if license_setup "${path}" "${force}"; then
+			checks+=("${path}")
+		else
+			exit_code=1
+		fi
+		popd >/dev/null
+	done
+
+	# run checks on the setup targets
+	if (( run_check )) && (( ${#checks[@]} >= 1 )); then
+		echo
+		echo 📡 Running checks...
+		pkgctl_license_check "${checks[@]}" || true
+	fi
+
+	return "$exit_code"
+}
+
+license_setup() {
+	local path=$1
+	local force=$2
+	local pkgbase pkgname license
+
+	if [[ ! -f PKGBUILD ]]; then
+		msg_error "${BOLD}${path}:${ALL_OFF} no PKGBUILD found"
+		return 1
+	fi
+
+	# shellcheck source=contrib/makepkg/PKGBUILD.proto
+	if ! . ./PKGBUILD; then
+		msg_error "${BOLD}${path}:${ALL_OFF} failed to source PKGBUILD"
+		return 1
+	fi
+	pkgbase=${pkgbase:-$pkgname}
+
+	# setup LICENSE file
+	if ! license_file_setup "${pkgbase}" "${force}"; then
+		return 1
+	fi
+
+	# setup REUSE.toml
+	if ! reuse_setup "${pkgbase}" "${force}" "${license[@]}"; then
+		return 1
+	fi
+}
+
+is_valid_license() {
+	local license_name=$1
+	local supported_licenses
+	supported_licenses=$(reuse supported-licenses | awk '{print $1}')
+	if grep --quiet "^${license_name}$" <<< "$supported_licenses"; then
+		return 0
+	else
+		return 1
+	fi
+}
+
+license_file_setup() {
+	local pkgbase=$1
+	local force=$2
+
+	local license_text
+	license_text=$(< "${_DEVTOOLS_LIBRARY_DIR}"/data/LICENSE)
+
+	# Write LICENSE file, or check if it mismatches
+	if (( force )) || [[ ! -f LICENSE ]]; then
+		printf "%s\n" "${license_text}" > LICENSE
+		msg_success "${BOLD}${pkgbase}:${ALL_OFF} successfully configured LICENSE"
+	elif [[ -f LICENSE ]]; then
+		# if there is a license file, check whether it has the text we expect
+		existing_license="$(< LICENSE)"
+		if [[ "${license_text}" != "${existing_license}" ]]; then
+			msg_error "${BOLD}${pkgbase}:${ALL_OFF} existing LICENSE file doesn't have expected content, use --force to overwrite"
+			return 1
+		fi
+	fi
+
+	# make sure the LICENSE file is found by REUSE
+	mkdir --parents LICENSES
+	ln --symbolic --force ../LICENSE LICENSES/0BSD.txt
+}
+
+reuse_default_annotations() {
+	cat << EOF
+version = 1
+
+[[annotations]]
+path = [
+    "PKGBUILD",
+    "README.md",
+    "keys/**",
+    ".SRCINFO",
+    ".gitignore",
+    ".nvchecker.toml",
+    "*.install",
+    "*.sysusers",
+    "*sysusers.conf",
+    "*.tmpfiles",
+    "*tmpfiles.conf",
+    "*.logrotate",
+    "*.pam",
+    "*.service",
+    "*.socket",
+    "*.timer",
+    "*.desktop",
+    "*.hook",
+]
+SPDX-FileCopyrightText = "Arch Linux contributors"
+SPDX-License-Identifier = "0BSD"
+EOF
+}
+
+reuse_setup() {
+	local pkgbase=$1
+	local force=$2
+	shift 2
+	local license=("$@")
+
+	# Check if REUSE.toml already exists
+	if (( ! force )) && [[ -f REUSE.toml ]]; then
+		msg_error "${BOLD}${pkgbase}:${ALL_OFF} REUSE.toml already exists, use --force to overwrite"
+		return 1
+	fi
+
+	reuse_default_annotations > REUSE.toml
+
+	local warning_occurred=0
+	local patches=(*.patch)
+	# If there are patches and there's only a single well-known license listed in the package,
+	# we can generate the annotations for the patches, otherwise we will fail to do so and warn
+	# the user.
+	if (( ${#patches} )); then
+		# If there are multiple licenses, we can't make a good guess about which license the
+		# patches should have. In case the first element contains a space, we are dealing with
+		# a complex SPDX license identifier.
+		if (( ${#license[@]} > 1 )) || [[ ${license[0]} =~ [[:space:]] ]]; then
+			msg_warn "${BOLD}${pkgbase}:${ALL_OFF} .patch files were found but couldn't automatically guess a suitable license because PKGBUILD has multiple licenses"
+			patch_annotations "${pkgbase}" "TODO-Choose-a-license" "${patches[@]}" >> REUSE.toml
+			warning_occurred=1
+		elif ! is_valid_license "${license[0]}"; then
+			msg_warn "${BOLD}${pkgbase}:${ALL_OFF} .patch files were found but couldn't automatically guess a suitable license because the PKGBUILD license '${license[0]}' is not a recognized SPDX license"
+			patch_annotations "${pkgbase}" "TODO-Choose-a-license" "${patches[@]}" >> REUSE.toml
+			warning_occurred=1
+		else
+			patch_annotations "${pkgbase}" "${license[0]}" "${patches[@]}" >> REUSE.toml
+		fi
+	fi
+
+	if (( warning_occurred )); then
+		msg_warn "${BOLD}${pkgbase}:${ALL_OFF} configured REUSE but a warning occurred, manually edit and fix REUSE.toml"
+		return 1
+	else
+		reuse download --all
+		msg_success "${BOLD}${pkgbase}:${ALL_OFF} successfully configured REUSE.toml"
+	fi
+}
+
+patch_annotations() {
+	local pkgbase=$1
+	local license_identifier=$2
+	shift 2
+	local patches=("$@")
+
+	local annotations
+	annotations+="\n[[annotations]]\n"
+	annotations+="path = [\n"
+	for patch in "${patches[@]}"; do
+		annotations+="    \"$(basename "${patch}")\",\n"
+	done
+	annotations+="]\n"
+	annotations+="SPDX-FileCopyrightText = \"${pkgbase} contributors\"\n"
+	annotations+="SPDX-License-Identifier = \"${license_identifier}\""
+	echo -e "${annotations}"
+}

src/lib/repo.sh

@@ -31,7 +31,6 @@ pkgctl_repo_usage() {
 		    clone          Clone a package repository
 		    configure      Configure a clone according to distro specs
 		    create         Create a new GitLab package repository
-		    pull           Update package repositories from their git remote
 		    switch         Switch a package repository to a specified version
 		    web            Open the packaging repository's website
 
@@ -41,7 +40,6 @@ pkgctl_repo_usage() {
 		EXAMPLES
 		    $ ${COMMAND} clean --interactive *
 		    $ ${COMMAND} clone libfoo linux libbar
-		    $ ${COMMAND} pull libfoo linux libbar
 		    $ ${COMMAND} clone --maintainer mynickname
 		    $ ${COMMAND} configure *
 		    $ ${COMMAND} create libfoo
@@ -103,14 +101,6 @@ pkgctl_repo() {
 				pkgctl_repo_switch "$@"
 				exit 0
 				;;
-			pull)
-				_DEVTOOLS_COMMAND+=" $1"
-				shift
-				# shellcheck source=src/lib/repo/pull.sh
-				source "${_DEVTOOLS_LIBRARY_DIR}"/lib/repo/pull.sh
-				pkgctl_repo_pull "$@"
-				exit 0
-				;;
 			web)
 				_DEVTOOLS_COMMAND+=" $1"
 				shift

src/lib/repo/pull.sh

@@ -1,195 +0,0 @@
-#!/bin/bash
-#
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-[[ -z ${DEVTOOLS_INCLUDE_REPO_PULL_SH:-} ]] || return 0
-DEVTOOLS_INCLUDE_REPO_PULL_SH=1
-
-_DEVTOOLS_LIBRARY_DIR=${_DEVTOOLS_LIBRARY_DIR:-@pkgdatadir@}
-# shellcheck source=src/lib/common.sh
-source "${_DEVTOOLS_LIBRARY_DIR}"/lib/common.sh
-# shellcheck source=src/lib/util/git.sh
-source "${_DEVTOOLS_LIBRARY_DIR}"/lib/util/git.sh
-
-source /usr/share/makepkg/util/message.sh
-
-set -eo pipefail
-
-
-pkgctl_repo_pull_usage() {
-	local -r COMMAND=${_DEVTOOLS_COMMAND:-${BASH_SOURCE[0]##*/}}
-	cat <<- _EOF_
-		Usage: ${COMMAND} [OPTIONS] [PKGBASE]...
-
-		Update package repositories from their git remotes.
-
-		OPTIONS
-		    --discard-changes   Discard changes if index or working tree is dirty
-		    --show-diff         Always enable showing the diff
-		    --autostash         Stash before pulling and unstash afterwards
-		    -j, --jobs N        Run up to N jobs in parallel (default: $(nproc))
-		    --quiet             Disable printing longer terminal output
-		    -h, --help          Show this help text
-
-		EXAMPLES
-		    $ ${COMMAND} gopass gopass-jsonapi
-_EOF_
-}
-
-pkgctl_repo_pull() {
-	# options
-	local paths path pkgbase branch jobs remote
-	jobs=$(nproc)
-	local command=${_DEVTOOLS_COMMAND:-${BASH_SOURCE[0]##*/}}
-	local git_rebase_options=()
-	local SHOW_DIFF=0
-	local QUIET=0
-	local DISCARD_CHANGES=0
-	local AUTOSTASH=0
-
-	while (( $# )); do
-		case $1 in
-			-h|--help)
-				pkgctl_repo_pull_usage
-				exit 0
-				;;
-			--discard-changes)
-				DISCARD_CHANGES=1
-				shift
-				;;
-			--show-diff)
-				SHOW_DIFF=1
-				shift
-				;;
-			--quiet)
-				QUIET=1
-				shift
-				;;
-			--autostash)
-				AUTOSTASH=1
-				git_rebase_options+=(--autostash)
-				shift
-				;;
-			-j|--jobs)
-				(( $# <= 1 )) && die "missing argument for %s" "$1"
-				jobs=$2
-				shift 2
-				;;
-			--)
-				shift
-				break
-				;;
-			-*)
-				die "invalid argument: %s" "$1"
-				;;
-			*)
-				paths=("$@")
-				break
-				;;
-		esac
-	done
-
-	# check if invoked without any path from within a packaging repo
-	if (( ${#paths[@]} == 0 )); then
-		paths=(".")
-	fi
-
-	# check if we are only working on one repo and enable
-	if (( ${#paths[@]} == 1 )) && (( ! QUIET )); then
-		SHOW_DIFF=1
-	fi
-
-	# parallelization
-	if [[ ${jobs} != 1 ]] && (( ${#paths[@]} > 1 )); then
-		if [[ -n ${BOLD} ]]; then
-			export DEVTOOLS_COLOR=always
-		fi
-
-		# warm up ssh connection as it may require user input (key unlock, hostkey verification etc)
-		git_warmup_ssh_connection
-
-		# disable diffs if not enabled explicitly
-		if (( ! SHOW_DIFF )); then
-			command+=" --quiet"
-		fi
-
-		if (( DISCARD_CHANGES )); then
-			command+=" --discard-changes"
-		fi
-
-		if (( AUTOSTASH )); then
-			command+=" --autostash"
-		fi
-
-		if ! parallel --bar --jobs "${jobs}" "${command}" ::: "${paths[@]}"; then
-			die 'Failed to pull some packages, please check the previous output'
-		fi
-		exit 0
-	fi
-
-	for path in "${paths[@]}"; do
-		# skip paths that are not directories
-		if [[ ! -d "${path}" ]]; then
-			continue
-		fi
-
-		if [[ ! -f "${path}/PKGBUILD" ]]; then
-			msg_error "  Not a package repository: ${path}"
-			continue
-		fi
-
-		if [[ ! -d "${path}/.git" ]]; then
-			msg_error "  Not a Git repository: ${path}"
-			continue
-		fi
-
-		pkgbase=$(basename "$(realpath "${path}")")
-		pkgbase=${pkgbase%.git}
-		msg "Updating ${pkgbase}"
-
-		branch=$(git -C "${path}" symbolic-ref --quiet --short HEAD)
-		if [[ ${branch} != main ]]; then
-			msg_warn "  Current branch is ${branch}, not updating from canonical upstream: ${pkgbase}"
-		fi
-
-		if ! git -C "${path}" diff-files --quiet && (( ! AUTOSTASH )) && (( ! DISCARD_CHANGES )); then
-			msg_error "  Index contains unstaged changes, please stash them or pass --autostash before pulling: ${pkgbase}"
-			continue
-		fi
-
-		if ! git -C "${path}" diff-index --cached --quiet HEAD && (( ! AUTOSTASH )) && (( ! DISCARD_CHANGES )); then
-			msg_error "  Index contains uncommited changes, please commit or stash them before pulling: ${pkgbase}"
-			continue
-		fi
-
-		remote=$(git -C "${path}" config "branch.${branch}.remote")
-		if [[ -z "${remote}" ]]; then
-			msg_error "  No upstream tracking branch configured: ${pkgbase}"
-			continue
-		fi
-
-		if ! git -C "${path}" fetch --quiet "${remote}"; then
-			msg_error "  Error while fetching: ${pkgbase}"
-			continue
-		fi
-
-		if [[ $(git -C "${path}" rev-parse HEAD) == $(git -C "${path}" rev-parse FETCH_HEAD) ]]; then
-			msg2 "Repo is up to date, nothing to do"
-			continue
-		fi
-
-		# discard any local modifications
-		if (( DISCARD_CHANGES )); then
-			git -C "${path}" restore --staged --worktree -- .
-		fi
-
-		if (( SHOW_DIFF )) && (( ! QUIET )); then
-			git -C "${path}" --no-pager diff --color --patch-with-stat HEAD..FETCH_HEAD
-		fi
-
-		if ! git -C "${path}" rebase --quiet "${git_rebase_options[@]}" "${remote}/${branch}"; then
-			msg_error "  Error while pulling in the changes for ${pkgbase}"
-			exit 1
-		fi
-	done
-}

src/lib/version/check.sh

@@ -140,6 +140,32 @@ pkgctl_version_check() {
 		pushd "${path}" >/dev/null
 
 		if [[ ${output_format} == pretty ]]; then
+			# initialize the tmp file for status output
+			section_separator=''
+			printf "" > "${status_dir}/tmp"
+
+			# update the current list of failed packages
+			if (( ${#failure[@]} > 0 )); then
+				exit_code=${PKGCTL_VERSION_CHECK_EXIT_FAILURE}
+				printf "%sFailure%s\n" "${section_separator}${BOLD}${UNDERLINE}" "${ALL_OFF}" >> "${status_dir}/tmp" 2>&1
+				section_separator=$'\n'
+				for result in "${failure[@]}"; do
+					msg_error " ${result}" >> "${status_dir}/tmp" 2>&1
+				done
+			fi
+
+			# update the current list of out-of-date packages
+			if (( ${#out_of_date[@]} > 0 )); then
+				exit_code=${PKGCTL_VERSION_CHECK_EXIT_OUT_OF_DATE}
+				printf "%sOut-of-date%s\n" "${section_separator}${BOLD}${UNDERLINE}" "${ALL_OFF}" >> "${status_dir}/tmp" 2>&1
+				section_separator=$'\n'
+				for result in "${out_of_date[@]}"; do
+					msg_warn " ${result}" >> "${status_dir}/tmp" 2>&1
+				done
+			fi
+
+			printf "%s" "${section_separator}" >> "${status_dir}/tmp"
+
 			# update the current terminal spinner status
 			(( ++current_item ))
 			pkgctl_version_check_spinner \
@@ -217,6 +243,9 @@ pkgctl_version_check() {
 		return 0
 	fi
 
+	# reset the section separator after loop
+	section_separator=''
+
 	if (( verbose )) && (( ${#up_to_date[@]} > 0 )); then
 		printf "%sUp-to-date%s\n" "${section_separator}${BOLD}${UNDERLINE}" "${ALL_OFF}"
 		section_separator=$'\n'
@@ -408,7 +437,7 @@ pkgctl_version_check_spinner() {
 	pkgctl_version_check_summary \
 		"${up_to_date_count}" \
 		"${out_of_date_count}" \
-		"${failure_count}" > "${tmp_file}"
+		"${failure_count}" >> "${tmp_file}"
 
 	# print the progress status
 	printf "📡 Checking: %s/%s [%s] %%spinner%%" \

src/pkgctl.in

@@ -25,6 +25,7 @@ usage() {
 		    db      Pacman database modification for package update, move etc
 		    diff    Compare package files using different modes
 		    issue   Work with GitLab packaging issues
+		    license Check and manage package licenses
 		    release Release step to commit, tag and upload build artifacts
 		    repo    Manage Git packaging repositories and their configuration
 		    search  Search for an expression across the GitLab packaging group
@@ -113,6 +114,14 @@ while (( $# )); do
 			pkgctl_issue "$@"
 			exit 0
 			;;
+		license)
+			_DEVTOOLS_COMMAND+=" $1"
+			shift
+			# shellcheck source=src/lib/license.sh
+			source "${_DEVTOOLS_LIBRARY_DIR}"/lib/license.sh
+			pkgctl_license "$@"
+			exit 0
+			;;
 		release)
 			_DEVTOOLS_COMMAND+=" $1"
 			shift