debian: Adjusting d/{configure,control,rules.in} to rebase and review

Author: smoe

debian/changelog

@@ -8,6 +8,9 @@ linuxcnc (1:2.10.0~pre0) UNRELEASED; urgency=medium
     depend on defaults passed by dpkg-buildflags on
     Ubuntu and Debian (LP: #2104012)
 
+  [ Steffen Moeller ]
+  * Introducing DEB_BUILD_OPTIONS to d/rules.
+
  -- Pushkar Kulkarni <pushkar.kulkarni@canonical.com>  Mon, 24 Mar 2025 20:50:08 +0530
 
 linuxcnc (1:2.9.4-2) unstable; urgency=medium

debian/configure

@@ -14,15 +14,25 @@ set -e
 
 usage () {
     P=${0##*/}
-    cat <<EOF
+    cat 1>&2 <<EOF
 $P: Set up debian/ files to build for a particular kernel
 
 Usage:
   $P [no-docs]
 
   Extra options:
-    no-docs
-        Skip building documentation
+
+    no-docs|nodocs
+        Skip building documentation.
+        Debian packaging will not know about documentation to exist at all.
+        If configured regularly but with the intent not to build the docs,
+        run "DEB_BUILD_OPTIONS=nodocs dpkg-buildpackage".
+
+    sim|uspace|noauto
+        Accepted for compatibility, but now ignored.
+
+    -h|--help|help
+	Show this help.
 EOF
 }
 
@@ -47,8 +57,12 @@ ENABLE_BUILD_DOCUMENTATION=--enable-build-documentation=pdf
 while test $# -ne 0; do
     case "$1" in
     sim|uspace|noauto) echo "$1 is accepted for compatibility, but ignored";;
-    no-docs) unset ENABLE_BUILD_DOCUMENTATION ;;
-    *) echo 1>&2 "Unknown option: $1"; exit 99 ;;
+    help|-h|--help) usage; exit 0 ;;
+    no-docs|nodocs) unset ENABLE_BUILD_DOCUMENTATION ;;
+    *)  echo 1>&2 "Unknown option: $1"
+        echo 1>&2
+	usage
+        exit 99 ;;
     esac
     shift
 done
@@ -201,5 +215,9 @@ echo "I: You can now start the build of LinuxCNC Debian packages."
 echo "   To build and test everything: fakeroot debian/rules binary"
 echo "   To build the executables and man pages only: fakeroot debian/rules binary-arch"
 echo "   To avoid tests: DEB_BUILD_OPTIONS=nocheck debian/rules binary"
-echo "   To avoid documentation: DEB_BUILD_OPTIONS=nodocs fakeroot debian/rules binary"
+if [ -n "$ENABLE_BUILD_DOCUMENTATION" ]; then
+    echo "   To avoid documentation: DEB_BUILD_OPTIONS=nodocs fakeroot debian/rules binary"
+else
+    echo "   Building of documentation is disabled."
+fi
 echo "   The DEB_BUILD_OPTIONS environment variable also works with dpkg-buildpackage."

debian/control.top.in

@@ -51,7 +51,9 @@ Build-Depends:
     yapps2
 Build-Depends-Indep:
     @DOC_DEPENDS@,
-Build-Conflicts-Arch: libjpeg8-dev, libtiff4-dev
+Build-Conflicts-Arch:
+    libjpeg8-dev,
+    libtiff4-dev
 Standards-Version: 4.7.2
 Homepage: https://linuxcnc.org/
 Vcs-Browser: https://github.com/LinuxCNC/linuxcnc

debian/rules.in

@@ -90,7 +90,7 @@ override_dh_auto_install-arch:
 override_dh_installdocs-arch:
 ifeq (,$(filter nodocs,$(DEB_BUILD_OPTIONS)))
 	# Sample configs go in `usr/share/doc/linuxcnc` (not `.../doc/@MAIN_PACKAGE_NAME@`)
-	# because that's where the  `linuxcnc` launcher script looks for them,
+	# because that's where the `linuxcnc` launcher script looks for them,
 	# and that's inconvenient to change.
 	dh_installdocs --doc-main-package=@MAIN_PACKAGE_NAME@ --package=@MAIN_PACKAGE_NAME@
 	mkdir -p debian/@MAIN_PACKAGE_NAME@/usr/share/doc/linuxcnc