commitpkg: handle option parsind and help before abort checks

Previously it was not possible to call for the help of find early
command line option problems when invoking in any location on the shell
as the command aborted without PKGBUILD being present.

Fix this by moving everything related to options at the very top.

.gitignore

@@ -1,24 +1,3 @@
 *~
 devtools-*.tar.gz*
-archbuild
+build/
-archco
-archrelease
-bash_completion
-checkpkg
-commitpkg
-diffpkg
-export-pkgbuild-keys
-finddeps
-lddd
-makechrootpkg
-makerepropkg
-mkarchroot
-offload-build
-rebuildpkgs
-zsh_completion
-find-libdeps
-crossrepomove
-arch-nspawn
-sogrep
-doc/*.1
-doc/*.7

Makefile

@@ -3,47 +3,13 @@ BUILDTOOLVER ?= $(V)
 
 PREFIX = /usr/local
 MANDIR = $(PREFIX)/share/man
+BUILDDIR = build
 
-IN_PROGS = \
+BINPROGS = $(addprefix $(BUILDDIR)/,$(patsubst src/%,bin/%,$(patsubst %.in,%,$(wildcard src/*.in))))
-	archco \
+MAKEPKG_CONFIGS=$(wildcard config/makepkg/*)
-	arch-nspawn \
+PACMAN_CONFIGS=$(wildcard config/pacman/*)
-	archrelease \
+SETARCH_ALIASES = $(wildcard config/setarch-aliases.d/*)
-	archbuild \
+MANS = $(addprefix $(BUILDDIR)/,$(patsubst %.asciidoc,%,$(wildcard doc/man/*.asciidoc)))
-	checkpkg \
-	commitpkg \
-	crossrepomove\
-	diffpkg \
-	export-pkgbuild-keys \
-	finddeps \
-	find-libdeps \
-	lddd \
-	makerepropkg \
-	mkarchroot \
-	makechrootpkg \
-	offload-build \
-	rebuildpkgs \
-	sogrep
-
-BINPROGS = \
-	$(IN_PROGS)
-
-CONFIGFILES = \
-	makepkg-x86_64.conf \
-	makepkg-x86_64_v3.conf \
-	pacman-extra.conf \
-	pacman-extra-x86_64_v3.conf \
-	pacman-testing.conf \
-	pacman-testing-x86_64_v3.conf \
-	pacman-staging.conf \
-	pacman-staging-x86_64_v3.conf \
-	pacman-multilib.conf \
-	pacman-multilib-testing.conf \
-	pacman-multilib-staging.conf \
-	pacman-kde-unstable.conf \
-	pacman-gnome-unstable.conf
-
-SETARCH_ALIASES = \
-	x86_64_v3
 
 COMMITPKG_LINKS = \
 	extrapkg \
@@ -75,71 +41,80 @@ CROSSREPOMOVE_LINKS = \
 	extra2community \
 	community2extra
 
+COMPLETIONS = $(addprefix $(BUILDDIR)/,$(patsubst %.in,%,$(wildcard contrib/completion/*/*)))
 BASHCOMPLETION_LINKS = \
 	archco \
 	communityco
 
 
-MANS = \
+all: binprogs completion man
-	doc/archbuild.1 \
+binprogs: $(BINPROGS)
-	doc/arch-nspawn.1 \
+completion: $(COMPLETIONS)
-	doc/export-pkgbuild-keys.1 \
-	doc/makechrootpkg.1 \
-	doc/lddd.1 \
-	doc/checkpkg.1 \
-	doc/diffpkg.1 \
-	doc/offload-build.1 \
-	doc/sogrep.1 \
-	doc/makerepropkg.1 \
-	doc/mkarchroot.1 \
-	doc/find-libdeps.1 \
-	doc/find-libprovides.1 \
-	doc/devtools.7
-
-
-all: $(BINPROGS) bash_completion zsh_completion man
 man: $(MANS)
 
+
+ifneq ($(wildcard *.in),)
+	$(error Legacy in prog file found: $(wildcard *.in) - please migrate to src/*)
+endif
+ifneq ($(wildcard pacman-*.conf),)
+	$(error Legacy pacman config file found: $(wildcard pacman-*.conf) - please migrate to config/pacman/*)
+endif
+ifneq ($(wildcard makepkg-*.conf),)
+	$(error Legacy makepkg config files found: $(wildcard makepkg-*.conf) -  please migrate to config/makepkg/*)
+endif
+ifneq ($(wildcard setarch-aliases.d/*),)
+	$(error Legacy setarch aliase found: $(wildcard setarch-aliases.d/*) - please migrate to config/setarch-aliases.d/*)
+endif
+
+
 edit = sed -e "s|@pkgdatadir[@]|$(PREFIX)/share/devtools|g"
+GEN_MSG = @echo "GEN $(patsubst $(BUILDDIR)/%,%,$@)"
 
-%: %.in Makefile lib/common.sh
+define buildInScript
-	@echo "GEN $@"
+$(1)/%: $(2)%.in
-	@$(RM) "$@"
+	$$(GEN_MSG)
-	@{ echo -n 'm4_changequote([[[,]]])'; cat $@.in; } | m4 -P --define=m4_devtools_version=$(BUILDTOOLVER) | $(edit) >$@
+	@mkdir -p $$(dir $$@)
-	@chmod a-w "$@"
+	@$(RM) "$$@"
-	@chmod +x "$@"
+	@{ echo -n 'm4_changequote([[[,]]])'; cat $$<; } | m4 -P --define=m4_devtools_version=$$(BUILDTOOLVER) | $(edit) >$$@
-	@bash -O extglob -n "$@"
+	@chmod $(3) "$$@"
+	@bash -O extglob -n "$$@"
+endef
 
-$(MANS): doc/asciidoc.conf doc/footer.asciidoc
+$(eval $(call buildInScript,build/bin,src/,555))
+$(foreach completion,$(wildcard contrib/completion/*),$(eval $(call buildInScript,build/$(completion),$(completion)/,444)))
 
-doc/%: doc/%.asciidoc
+$(BUILDDIR)/doc/man/%: doc/man/%.asciidoc doc/asciidoc.conf doc/man/include/footer.asciidoc
-	a2x --no-xmllint --asciidoc-opts="-f doc/asciidoc.conf" -d manpage -f manpage -D doc -a pkgdatadir=$(PREFIX)/share/devtools $<
+	$(GEN_MSG)
+	@mkdir -p $(BUILDDIR)/doc/man
+	@a2x --no-xmllint --asciidoc-opts="-f doc/asciidoc.conf" -d manpage -f manpage --destination-dir=$(BUILDDIR)/doc/man -a pkgdatadir=$(PREFIX)/share/devtools $<
 
 clean:
-	rm -f $(IN_PROGS) bash_completion zsh_completion $(MANS)
+	rm -rf $(BUILDDIR)
 
-install:
+install: all
 	install -dm0755 $(DESTDIR)$(PREFIX)/bin
 	install -dm0755 $(DESTDIR)$(PREFIX)/share/devtools/setarch-aliases.d
 	install -m0755 ${BINPROGS} $(DESTDIR)$(PREFIX)/bin
-	install -m0644 ${CONFIGFILES} $(DESTDIR)$(PREFIX)/share/devtools
+	for conf in ${MAKEPKG_CONFIGS}; do install -Dm0644 $$conf $(DESTDIR)$(PREFIX)/share/devtools/makepkg-$${conf##*/}; done
-	for a in ${SETARCH_ALIASES}; do install -m0644 setarch-aliases.d/$$a $(DESTDIR)$(PREFIX)/share/devtools/setarch-aliases.d; done
+	for conf in ${PACMAN_CONFIGS}; do install -Dm0644 $$conf $(DESTDIR)$(PREFIX)/share/devtools/pacman-$${conf##*/}; done
+	for a in ${SETARCH_ALIASES}; do install -m0644 $$a -t $(DESTDIR)$(PREFIX)/share/devtools/setarch-aliases.d; done
 	for l in ${COMMITPKG_LINKS}; do ln -sf commitpkg $(DESTDIR)$(PREFIX)/bin/$$l; done
 	for l in ${ARCHBUILD_LINKS}; do ln -sf archbuild $(DESTDIR)$(PREFIX)/bin/$$l; done
 	for l in ${CROSSREPOMOVE_LINKS}; do ln -sf crossrepomove $(DESTDIR)$(PREFIX)/bin/$$l; done
 	ln -sf find-libdeps $(DESTDIR)$(PREFIX)/bin/find-libprovides
-	install -Dm0644 bash_completion $(DESTDIR)$(PREFIX)/share/bash-completion/completions/devtools
+	install -Dm0644 $(BUILDDIR)/contrib/completion/bash/devtools $(DESTDIR)$(PREFIX)/share/bash-completion/completions/devtools
 	for l in ${BASHCOMPLETION_LINKS}; do ln -sf devtools $(DESTDIR)$(PREFIX)/share/bash-completion/completions/$$l; done
-	install -Dm0644 zsh_completion $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_devtools
+	install -Dm0644 $(BUILDDIR)/contrib/completion/zsh/_devtools $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_devtools
 	ln -sf archco $(DESTDIR)$(PREFIX)/bin/communityco
 	for manfile in $(MANS); do \
 		install -Dm644 $$manfile -t $(DESTDIR)$(MANDIR)/man$${manfile##*.}; \
 	done;
 
 uninstall:
-	for f in ${BINPROGS}; do rm -f $(DESTDIR)$(PREFIX)/bin/$$f; done
+	for f in $(notdir $(BINPROGS)); do rm -f $(DESTDIR)$(PREFIX)/bin/$$f; done
-	for f in ${CONFIGFILES}; do rm -f $(DESTDIR)$(PREFIX)/share/devtools/$$f; done
+	for conf in ${MAKEPKG_CONFIGS}; do rm -f $(DESTDIR)$(PREFIX)/share/devtools/makepkg-$${conf##*/}; done
-	for f in ${SETARCH_ALIASES}; do rm -f $(DESTDIR)$(PREFIX)/share/devtools/setarch-aliases.d/$$f; done
+	for conf in ${PACMAN_CONFIGS}; do rm -f $(DESTDIR)$(PREFIX)/share/devtools/pacman-$${conf##*/}; done
+	for f in $(notdir $(SETARCH_ALIASES)); do rm -f $(DESTDIR)$(PREFIX)/share/devtools/setarch-aliases.d/$$f; done
 	for l in ${COMMITPKG_LINKS}; do rm -f $(DESTDIR)$(PREFIX)/bin/$$l; done
 	for l in ${ARCHBUILD_LINKS}; do rm -f $(DESTDIR)$(PREFIX)/bin/$$l; done
 	for l in ${CROSSREPOMOVE_LINKS}; do rm -f $(DESTDIR)$(PREFIX)/bin/$$l; done
@@ -148,9 +123,8 @@ uninstall:
 	rm $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_devtools
 	rm -f $(DESTDIR)$(PREFIX)/bin/communityco
 	rm -f $(DESTDIR)$(PREFIX)/bin/find-libprovides
-	for manfile in $(MANS); do \
+	for manfile in $(notdir $(MANS)); do rm -f $(DESTDIR)$(MANDIR)/man$${manfile##*.}/$${manfile}; done;
-		rm -f $(DESTDIR)$(MANDIR)/man$${manfile##*.}/$${manfile#doc/}; \
+	rmdir --ignore-fail-on-non-empty $(DESTDIR)$(PREFIX)/share/devtools/setarch-aliases.d $(DESTDIR)$(PREFIX)/share/devtools
-	done;
 
 TODAY=$(shell date +"%Y%m%d")
 tag:
@@ -165,8 +139,8 @@ dist:
 upload:
 	scp devtools-$(V).tar.gz devtools-$(V).tar.gz.sig repos.archlinux.org:/srv/ftp/other/devtools/
 
-check: $(BINPROGS) bash_completion makepkg-x86_64.conf PKGBUILD.proto
+check: $(BINPROGS) $(BUILDDIR)/contrib/completion/bash/devtools config/makepkg/x86_64.conf contrib/makepkg/PKGBUILD.proto
 	shellcheck $^
 
-.PHONY: all clean install uninstall dist upload check tag
+.PHONY: all completion man clean install uninstall dist upload check tag
 .DELETE_ON_ERROR:

README.md

@@ -3,17 +3,6 @@
 This repository contains tools for the Arch Linux distribution for building
 and maintaining official repository packages.
 
-## Patches
-
-Patches can be send to arch-projects@archlinux.org or via a pull request on
-Github. When sending patches to the mailing list make sure to set a valid
-subjectprefix otherwise the email is denied by mailman. Git can be configured
-as following.
-
-```
-git config format.subjectprefix 'devtools] [PATCH'
-```
-
 ## Building
 
 When building official distro packages the `BUILDTOOLVER` needs to be set to the

doc/man/arch-nspawn.1.asciidoc

@@ -37,4 +37,4 @@ Options
 *-h*::
 	Show this usage message
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/archbuild.1.asciidoc

@@ -44,4 +44,4 @@ See Also
 
 linkman:devtools[7]
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/checkpkg.1.asciidoc

@@ -40,4 +40,4 @@ See Also
 
 linkman:find-libprovides[1]
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/devtools.7.asciidoc

@@ -25,7 +25,7 @@ linkman:arch-nspawn[1]
 	Run a command or OS in a light-weight namespace container
 
 linkman:checkpkg[1]
-	Compare the current build pakcage with the repository version
+	Compare the current build package with the repository version
 
 linkman:find-libdeps[1]
 	Find soname dependencies for a package
@@ -52,4 +52,4 @@ linkman:offload-build[1]
 linkman:sogrep[1]
 	Find packages using a linked to a given shared library
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/diffpkg.1.asciidoc

@@ -54,4 +54,4 @@ Modes
 See Also
 --------
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/export-pkgbuild-keys.1.asciidoc

@@ -22,4 +22,4 @@ Options
 *-h, --help*::
 	Show a help text.
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/find-libdeps.1.asciidoc

@@ -21,4 +21,4 @@ Options
 	Ignore internal libraries.
 
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/find-libprovides.1.asciidoc

@@ -21,4 +21,4 @@ Options
 *--ignore-internal*::
 	Ignore internal libraries.
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/include/footer.asciidoc

@@ -1,9 +1,7 @@
 
 Bugs
 ----
-Bugs can be reported on the bug tracker 'https://bugs.archlinux.org' in the Arch
+Bugs can be reported on the project's GitLab bug tracker 'https://gitlab.archlinux.org/archlinux/devtools'
-Linux category and title prefixed with [devtools] or via
-mailto:arch-projects@archlinux.org[].
 
 
 Authors

doc/man/lddd.1.asciidoc

@@ -22,4 +22,4 @@ See Also
 
 linkman:ldd[1]
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/makechrootpkg.1.asciidoc

@@ -73,4 +73,4 @@ Options
 *-U*::
 	Run makepkg as a specified user
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/makerepropkg.1.asciidoc

@@ -56,4 +56,4 @@ Options
 *-h*::
 	Show this usage message
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/mkarchroot.1.asciidoc

@@ -46,4 +46,4 @@ See Also
 
 linkman:pacman[1]
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/offload-build.1.asciidoc

@@ -49,4 +49,4 @@ Example: To use a second `testing-x86_64-build` instance with another copydir:
 
 	`offload-build -r testing -- -- -l <chroot_copy>`
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

doc/man/sogrep.1.asciidoc

@@ -45,4 +45,4 @@ Environment Variables
 	directory set by the **XDG_CACHE_HOME** environment variable or the
 	**HOME** environment variable if **XDG_CACHE_HOME** is not set.
 
-include::footer.asciidoc[]
+include::include/footer.asciidoc[]

src/checkpkg.in

@@ -63,7 +63,7 @@ done
 
 # Source makepkg.conf; fail if it is not found
 if [[ -r "${MAKEPKG_CONF}" ]]; then
-	# shellcheck source=makepkg-x86_64.conf
+	# shellcheck source=config/makepkg/x86_64.conf
 	source "${MAKEPKG_CONF}"
 else
 	die "${MAKEPKG_CONF} not found!"
@@ -82,7 +82,7 @@ if [[ ! -f PKGBUILD ]]; then
 	die 'This must be run in the directory of a built package.'
 fi
 
-# shellcheck source=PKGBUILD.proto
+# shellcheck source=contrib/makepkg/PKGBUILD.proto
 . ./PKGBUILD
 if [[ ${arch[0]} == 'any' ]]; then
 	CARCH='any'

src/commitpkg.in

@@ -6,7 +6,7 @@ m4_include(lib/common.sh)
 
 # Source makepkg.conf; fail if it is not found
 if [[ -r '/etc/makepkg.conf' ]]; then
-	# shellcheck source=makepkg-x86_64.conf
+	# shellcheck source=config/makepkg/x86_64.conf
 	source '/etc/makepkg.conf'
 else
 	die '/etc/makepkg.conf not found!'
@@ -22,16 +22,8 @@ elif [[ -r "$HOME/.makepkg.conf" ]]; then
 fi
 
 cmd=${0##*/}
-
+rsyncopts=(-e ssh -p '--chmod=ug=rw,o=r' -c -h -L --progress --partial -y)
-if [[ ! -f PKGBUILD ]]; then
+archreleaseopts=()
-	die 'No PKGBUILD file'
-fi
-
-source=()
-# shellcheck source=PKGBUILD.proto
-. ./PKGBUILD
-pkgbase=${pkgbase:-$pkgname}
-
 case "$cmd" in
 	commitpkg)
 		if (( $# == 0 )); then
@@ -47,7 +39,26 @@ case "$cmd" in
 		die 'Usage: commitpkg <reponame> [-f] [-s server] [-l limit] [-a arch] [commit message]'
 		;;
 esac
+while getopts ':l:a:s:f' flag; do
+	case $flag in
+		f) archreleaseopts+=('-f') ;;
+		s) server=$OPTARG ;;
+		l) rsyncopts+=("--bwlimit=$OPTARG") ;;
+		a) commit_arch=$OPTARG ;;
+		:) die "Option requires an argument -- '%s'" "$OPTARG" ;;
+		\?) die "Invalid option -- '%s'" "$OPTARG" ;;
+	esac
+done
+shift $(( OPTIND - 1 ))
 
+if [[ ! -f PKGBUILD ]]; then
+	die 'No PKGBUILD file'
+fi
+
+source=()
+# shellcheck source=contrib/makepkg/PKGBUILD.proto
+. ./PKGBUILD
+pkgbase=${pkgbase:-$pkgname}
 
 if (( ${#validpgpkeys[@]} != 0 )); then
 	if [[ -d keys ]]; then
@@ -88,20 +99,6 @@ if (( ${#needsversioning[*]} )); then
 	(( ${#unversioned[*]} )) && die "%s is not under version control" "${unversioned[@]}"
 fi
 
-rsyncopts=(-e ssh -p '--chmod=ug=rw,o=r' -c -h -L --progress --partial -y)
-archreleaseopts=()
-while getopts ':l:a:s:f' flag; do
-	case $flag in
-		f) archreleaseopts+=('-f') ;;
-		s) server=$OPTARG ;;
-		l) rsyncopts+=("--bwlimit=$OPTARG") ;;
-		a) commit_arch=$OPTARG ;;
-		:) die "Option requires an argument -- '%s'" "$OPTARG" ;;
-		\?) die "Invalid option -- '%s'" "$OPTARG" ;;
-	esac
-done
-shift $(( OPTIND - 1 ))
-
 # check packages for validity
 for _arch in "${arch[@]}"; do
 	if [[ -n $commit_arch && ${_arch} != "$commit_arch" ]]; then

src/crossrepomove.in

@@ -45,7 +45,7 @@ msg "Downloading sources for %s" "${pkgbase}"
 svn -q checkout -N "${target_svn}" target_checkout
 mkdir -p "target_checkout/${pkgbase}/repos"
 svn -q export "${source_svn}/${pkgbase}/trunk" "target_checkout/${pkgbase}/trunk" || die
-# shellcheck source=PKGBUILD.proto
+# shellcheck source=contrib/makepkg/PKGBUILD.proto
 . "target_checkout/${pkgbase}/trunk/PKGBUILD"
 
 msg "Downloading packages for %s" "${pkgbase}"

src/diffpkg.in

@@ -92,7 +92,7 @@ fi
 
 # Source makepkg.conf; fail if it is not found
 if [[ -r "${MAKEPKG_CONF}" ]]; then
-	# shellcheck source=makepkg-x86_64.conf
+	# shellcheck source=config/makepkg/x86_64.conf
 	source "${MAKEPKG_CONF}"
 else
 	die "${MAKEPKG_CONF} not found!"
@@ -196,7 +196,7 @@ if (( $# < 2 )); then
 		die "This must be run in the directory of a built package.\nTry '$(basename "$0") --help' for more information."
 	fi
 
-	# shellcheck source=PKGBUILD.proto
+	# shellcheck source=contrib/makepkg/PKGBUILD.proto
 	. ./PKGBUILD
 	if [[ ${arch[0]} == 'any' ]]; then
 		CARCH='any'

src/finddeps.in

@@ -20,7 +20,7 @@ fi
 find . -type d -print0 2>/dev/null| while read -r -d '' d; do
 	if [[ -f "$d/PKGBUILD" ]]; then
 		pkgname=() depends=() makedepends=() optdepends=()
-		# shellcheck source=PKGBUILD.proto
+		# shellcheck source=contrib/makepkg/PKGBUILD.proto
 		. "$d/PKGBUILD"
 		for dep in "${depends[@]}"; do
 			# lose the version comparator, if any

src/rebuildpkgs.in

@@ -22,7 +22,7 @@ fi
 
 # Source makepkg.conf; fail if it is not found
 if [[ -r '/etc/makepkg.conf' ]]; then
-	# shellcheck source=makepkg-x86_64.conf
+	# shellcheck source=config/makepkg/x86_64.conf
 	source '/etc/makepkg.conf'
 else
 	die '/etc/makepkg.conf not found!'
@@ -54,7 +54,7 @@ bump_pkgrel() {
 pkg_from_pkgbuild() {
 	# we want the sourcing to be done in a subshell so we don't pollute our current namespace
 	export CARCH PKGEXT
-	# shellcheck source=PKGBUILD.proto
+	# shellcheck source=contrib/makepkg/PKGBUILD.proto
 	(source PKGBUILD; echo "$pkgname-$pkgver-$pkgrel-$CARCH$PKGEXT")
 }