debian: make package "official"

Move us into place in debian/

Signed-off-by: David Lamparter <equinox@diac24.net>

46 files changed, 82 insertions, 200 deletions

diff --git a/Makefile.am b/Makefile.am
index 9e6c53d87c..72db44e190 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -124,7 +124,7 @@ include watchfrr/subdir.am
 include qpb/subdir.am
 include fpm/subdir.am
 include tools/subdir.am
-include debianpkg/subdir.am
+include debian/subdir.am
 include solaris/subdir.am
 
 include bgpd/subdir.am
diff --git a/configure.ac b/configure.ac
index 710c5e9a52..7a748e9fdf 100755
--- a/configure.ac
+++ b/configure.ac
@@ -2198,7 +2198,7 @@ AC_CONFIG_FILES([
 	  config.version
 	  redhat/frr.spec
 	  solaris/Makefile
-	  debianpkg/changelog-auto
+	  debian/changelog-auto
 	  alpine/APKBUILD
 	  snapcraft/snapcraft.yaml
 	  lib/version.h
diff --git a/debianpkg/.gitignore b/debian/.gitignore
index b48b513813..b48b513813 100644
--- a/debianpkg/.gitignore
+++ b/debian/.gitignore
diff --git a/debianpkg/README.Debian b/debian/README.Debian
index 6d6c60bef1..47a353310d 100644
--- a/debianpkg/README.Debian
+++ b/debian/README.Debian
@@ -22,8 +22,8 @@ which itself is a fork of Zebra.
 Zebra was developed by Kunihiro Ishiguro.
 
 
-* Build Profiles used in the upstream debianpkg/
-================================================
+* Build Profiles used in the upstream debian/
+=============================================
 
 The following Build Profiles have been added:
 
diff --git a/debianpkg/README.Maintainer b/debian/README.Maintainer
index 9030022c5e..9030022c5e 100644
--- a/debianpkg/README.Maintainer
+++ b/debian/README.Maintainer
diff --git a/debianpkg/changelog b/debian/changelog
index be6099f8d4..be6099f8d4 120000
--- a/debianpkg/changelog
+++ b/debian/changelog
diff --git a/debianpkg/changelog-auto.in b/debian/changelog-auto.in
index 127d7fe147..127d7fe147 100644
--- a/debianpkg/changelog-auto.in
+++ b/debian/changelog-auto.in
diff --git a/debianpkg/compat b/debian/compat
index ec635144f6..ec635144f6 100644
--- a/debianpkg/compat
+++ b/debian/compat
diff --git a/debianpkg/control b/debian/control
index e8dbaf4aaa..e8dbaf4aaa 100644
--- a/debianpkg/control
+++ b/debian/control
diff --git a/debianpkg/copyright b/debian/copyright
index dbdc6b433c..dbdc6b433c 100644
--- a/debianpkg/copyright
+++ b/debian/copyright
diff --git a/debianpkg/frr-dbg.lintian-overrides b/debian/frr-dbg.lintian-overrides
index b18c555444..b18c555444 100644
--- a/debianpkg/frr-dbg.lintian-overrides
+++ b/debian/frr-dbg.lintian-overrides
diff --git a/debianpkg/frr-doc.doc-base b/debian/frr-doc.doc-base
index ec7870d7aa..ec7870d7aa 100644
--- a/debianpkg/frr-doc.doc-base
+++ b/debian/frr-doc.doc-base
diff --git a/debianpkg/frr-doc.info b/debian/frr-doc.info
index a83255a24f..a83255a24f 100644
--- a/debianpkg/frr-doc.info
+++ b/debian/frr-doc.info
diff --git a/debianpkg/frr-doc.install b/debian/frr-doc.install
index c48dc5a8db..c48dc5a8db 100644
--- a/debianpkg/frr-doc.install
+++ b/debian/frr-doc.install
diff --git a/debianpkg/frr-doc.lintian-overrides b/debian/frr-doc.lintian-overrides
index d4ada822a5..d4ada822a5 100644
--- a/debianpkg/frr-doc.lintian-overrides
+++ b/debian/frr-doc.lintian-overrides
diff --git a/debianpkg/frr-pythontools.install b/debian/frr-pythontools.install
index 28140382f6..28140382f6 100644
--- a/debianpkg/frr-pythontools.install
+++ b/debian/frr-pythontools.install
diff --git a/debianpkg/frr-pythontools.lintian-overrides b/debian/frr-pythontools.lintian-overrides
index d4ada822a5..d4ada822a5 100644
--- a/debianpkg/frr-pythontools.lintian-overrides
+++ b/debian/frr-pythontools.lintian-overrides
diff --git a/debianpkg/frr-rpki-rtrlib.install b/debian/frr-rpki-rtrlib.install
index 0465c0d910..0465c0d910 100644
--- a/debianpkg/frr-rpki-rtrlib.install
+++ b/debian/frr-rpki-rtrlib.install
diff --git a/debianpkg/frr-rpki-rtrlib.lintian-overrides b/debian/frr-rpki-rtrlib.lintian-overrides
index 3927731760..3927731760 100644
--- a/debianpkg/frr-rpki-rtrlib.lintian-overrides
+++ b/debian/frr-rpki-rtrlib.lintian-overrides
diff --git a/debianpkg/frr-snmp.install b/debian/frr-snmp.install
index 5517ca7eec..5517ca7eec 100644
--- a/debianpkg/frr-snmp.install
+++ b/debian/frr-snmp.install
diff --git a/debianpkg/frr-snmp.lintian-overrides b/debian/frr-snmp.lintian-overrides
index d4ada822a5..d4ada822a5 100644
--- a/debianpkg/frr-snmp.lintian-overrides
+++ b/debian/frr-snmp.lintian-overrides
diff --git a/debianpkg/frr.conf b/debian/frr.conf
index dee3cd849a..dee3cd849a 100644
--- a/debianpkg/frr.conf
+++ b/debian/frr.conf
diff --git a/debianpkg/frr.dirs b/debian/frr.dirs
index 4b05c8c907..4b05c8c907 100644
--- a/debianpkg/frr.dirs
+++ b/debian/frr.dirs
diff --git a/debianpkg/frr.docs b/debian/frr.docs
index 34dbbd7bc7..34dbbd7bc7 100644
--- a/debianpkg/frr.docs
+++ b/debian/frr.docs
diff --git a/debianpkg/frr.install b/debian/frr.install
index 3dff5baae5..3dff5baae5 100644
--- a/debianpkg/frr.install
+++ b/debian/frr.install
diff --git a/debianpkg/frr.lintian-overrides b/debian/frr.lintian-overrides
index 4df816fa05..4df816fa05 100644
--- a/debianpkg/frr.lintian-overrides
+++ b/debian/frr.lintian-overrides
diff --git a/debianpkg/frr.logrotate b/debian/frr.logrotate
index 1dc9122ac4..1dc9122ac4 100644
--- a/debianpkg/frr.logrotate
+++ b/debian/frr.logrotate
diff --git a/debianpkg/frr.manpages b/debian/frr.manpages
index f5aa972304..f5aa972304 100644
--- a/debianpkg/frr.manpages
+++ b/debian/frr.manpages
diff --git a/debianpkg/frr.pam b/debian/frr.pam
index 2b106d43bc..2b106d43bc 100644
--- a/debianpkg/frr.pam
+++ b/debian/frr.pam
diff --git a/debianpkg/frr.postinst b/debian/frr.postinst
index 130903ca0b..130903ca0b 100644
--- a/debianpkg/frr.postinst
+++ b/debian/frr.postinst
diff --git a/debianpkg/frr.postrm b/debian/frr.postrm
index aef06adcb9..aef06adcb9 100644
--- a/debianpkg/frr.postrm
+++ b/debian/frr.postrm
diff --git a/debianpkg/frr.preinst b/debian/frr.preinst
index 1c141f37f9..1c141f37f9 100644
--- a/debianpkg/frr.preinst
+++ b/debian/frr.preinst
diff --git a/debianpkg/frr.prerm b/debian/frr.prerm
index 090cd5752a..090cd5752a 100644
--- a/debianpkg/frr.prerm
+++ b/debian/frr.prerm
diff --git a/debianpkg/not-installed b/debian/not-installed
index 1a89f35853..1a89f35853 100644
--- a/debianpkg/not-installed
+++ b/debian/not-installed
diff --git a/debianpkg/rules b/debian/rules
index bc7d4de269..c35b46cf4e 100755
--- a/debianpkg/rules
+++ b/debian/rules
@@ -103,5 +103,5 @@ override_dh_missing:
 
 override_dh_auto_clean:
 # we generally do NOT want a full distclean since that wipes both
-# debianpkg/changelog and config.version
+# debian/changelog and config.version
 	if test -f Makefile; then make redistclean; fi
diff --git a/debianpkg/source/format b/debian/source/format
index af745b310b..af745b310b 100644
--- a/debianpkg/source/format
+++ b/debian/source/format
diff --git a/debianpkg/source/lintian-overrides b/debian/source/lintian-overrides
index cebc81fddf..cebc81fddf 100644
--- a/debianpkg/source/lintian-overrides
+++ b/debian/source/lintian-overrides
diff --git a/debian/subdir.am b/debian/subdir.am
new file mode 100644
index 0000000000..05dd77e62c
--- /dev/null
+++ b/debian/subdir.am
@@ -0,0 +1,45 @@
+#
+# debian
+#
+
+EXTRA_DIST += \
+	debian/README.Debian \
+	debian/README.Maintainer \
+	debian/changelog \
+	debian/changelog-auto \
+	debian/compat \
+	debian/control \
+	debian/copyright \
+	debian/rules \
+	debian/source/format \
+	debian/source/lintian-overrides \
+	debian/tests/control \
+	debian/tests/daemons \
+	debian/watchfrr.rc \
+	debian/watch \
+	\
+	debian/frr-dbg.lintian-overrides \
+	debian/frr-doc.doc-base \
+	debian/frr-doc.info \
+	debian/frr-doc.install \
+	debian/frr-doc.lintian-overrides \
+	debian/frr-pythontools.install \
+	debian/frr-pythontools.lintian-overrides \
+	debian/frr-rpki-rtrlib.install \
+	debian/frr-rpki-rtrlib.lintian-overrides \
+	debian/frr-snmp.install \
+	debian/frr-snmp.lintian-overrides \
+	debian/frr.conf \
+	debian/frr.dirs \
+	debian/frr.docs \
+	debian/frr.install \
+	debian/frr.lintian-overrides \
+	debian/frr.logrotate \
+	debian/frr.manpages \
+	debian/frr.pam \
+	debian/frr.postinst \
+	debian/frr.postrm \
+	debian/frr.preinst \
+	debian/frr.prerm \
+	debian/not-installed \
+	# end
diff --git a/debianpkg/tests/control b/debian/tests/control
index 53fd537e2e..53fd537e2e 100644
--- a/debianpkg/tests/control
+++ b/debian/tests/control
diff --git a/debianpkg/tests/daemons b/debian/tests/daemons
index 43966c8347..43966c8347 100644
--- a/debianpkg/tests/daemons
+++ b/debian/tests/daemons
diff --git a/debianpkg/watch b/debian/watch
index c286392d7e..c286392d7e 100644
--- a/debianpkg/watch
+++ b/debian/watch
diff --git a/debianpkg/watchfrr.rc b/debian/watchfrr.rc
index 4110b86399..4110b86399 100644
--- a/debianpkg/watchfrr.rc
+++ b/debian/watchfrr.rc
diff --git a/debianpkg/subdir.am b/debianpkg/subdir.am
deleted file mode 100644
index 196363c68b..0000000000
--- a/debianpkg/subdir.am
+++ /dev/null
@@ -1,45 +0,0 @@
-#
-# debianpkg
-#
-
-EXTRA_DIST += \
-	debianpkg/README.Debian \
-	debianpkg/README.Maintainer \
-	debianpkg/changelog \
-	debianpkg/changelog-auto \
-	debianpkg/compat \
-	debianpkg/control \
-	debianpkg/copyright \
-	debianpkg/rules \
-	debianpkg/source/format \
-	debianpkg/source/lintian-overrides \
-	debianpkg/tests/control \
-	debianpkg/tests/daemons \
-	debianpkg/watchfrr.rc \
-	debianpkg/watch \
-	\
-	debianpkg/frr-dbg.lintian-overrides \
-	debianpkg/frr-doc.doc-base \
-	debianpkg/frr-doc.info \
-	debianpkg/frr-doc.install \
-	debianpkg/frr-doc.lintian-overrides \
-	debianpkg/frr-pythontools.install \
-	debianpkg/frr-pythontools.lintian-overrides \
-	debianpkg/frr-rpki-rtrlib.install \
-	debianpkg/frr-rpki-rtrlib.lintian-overrides \
-	debianpkg/frr-snmp.install \
-	debianpkg/frr-snmp.lintian-overrides \
-	debianpkg/frr.conf \
-	debianpkg/frr.dirs \
-	debianpkg/frr.docs \
-	debianpkg/frr.install \
-	debianpkg/frr.lintian-overrides \
-	debianpkg/frr.logrotate \
-	debianpkg/frr.manpages \
-	debianpkg/frr.pam \
-	debianpkg/frr.postinst \
-	debianpkg/frr.postrm \
-	debianpkg/frr.preinst \
-	debianpkg/frr.prerm \
-	debianpkg/not-installed \
-	# end
diff --git a/doc/developer/maintainer-release-build.rst b/doc/developer/maintainer-release-build.rst
index 85aaa5365a..7792173034 100644
--- a/doc/developer/maintainer-release-build.rst
+++ b/doc/developer/maintainer-release-build.rst
@@ -37,7 +37,7 @@ Release Build Procedure for FRR Maintainers
 
 4. Update Changelog for Debian Packages:
 
-   Edit :file:`debianpkg/changelog.in`:
+   Edit :file:`debian/changelog-auto.in`:
 
    - Change last (top of list) entry from ``@VERSION@`` to previous fixed
      version number, i.e.::
diff --git a/doc/developer/packaging-debian.rst b/doc/developer/packaging-debian.rst
index c812a38212..1ace8f5f78 100644
--- a/doc/developer/packaging-debian.rst
+++ b/doc/developer/packaging-debian.rst
@@ -1,29 +1,16 @@
 Packaging Debian
 ================
 
-(Tested on Ubuntu 12.04, 14.04, 16.04, 17.10, 18.04, Debian 8 and 9)
-
-.. note::
-
-   If you try to build for a different distro, then it will most likely fail
-   because of the missing backport. See :ref:`deb-backports` about adding a new
-   backport.
+(Tested on Ubuntu 14.04, 16.04, 17.10, 18.04, Debian jessie, stretch and
+buster.)
 
 1. Install build dependencies for your platform as outlined in :ref:`building`.
 
-2. Install the following additional packages:
-
-   - on Ubuntu 12.04, 14.04, 16.04, 17.10, Debian 8 and 9:
-
-   .. code-block:: shell
-
-      apt-get install realpath equivs groff fakeroot debhelper devscripts
-
-   - on Ubuntu 18.04: (realpath is now part of preinstalled by coreutils)
+2. Install the general Debian package building tools:
 
    .. code-block:: shell
 
-      apt-get install equivs groff fakeroot debhelper devscripts
+      apt-get install equivs fakeroot debhelper devscripts
 
 3. Checkout FRR under a **unprivileged** user account:
 
@@ -38,13 +25,21 @@ Packaging Debian
 
       git checkout <branch>
 
-4. Run ``bootstrap.sh`` and make a dist tarball:
+4. Build Debian package dependencies and install them as needed.
+
+   .. code-block:: shell
+
+      sudo mk-build-deps --install debian/control
+
+5. Run ``bootstrap.sh``:
+
+   (This step should be omitted if you are using a "debian" branch, as opposed
+   to the "master", a "stable/X.X" or any other non-"debian" branch.)
 
    .. code-block:: shell
 
       ./bootstrap.sh
       ./configure --with-pkg-extra-version=-MyDebPkgVersion
-      make dist
 
    .. note::
 
@@ -52,48 +47,7 @@ Packaging Debian
       except the `with-pkg-extra-version` if you want to give the Debian
       package a specific name to mark your own unoffical build.
 
-5. Edit :file:`debianpkg/rules` and set the configuration as needed.
-
-   Look for section ``dh_auto_configure`` to modify the configure options as
-   needed. Options might be different between the top-level ``rules``` and
-   :file:`backports/XXXX/debian/rules`. Please adjust as needed on all files.
-
-6. Create backports debian sources
-
-   Rename the :file:`debianpkg` directory to :file:`debian` and create the
-   backports (Debian requires to not ship a :file:`debian` directory inside the
-   source directory to avoid build conflicts with the reserved ``debian``
-   subdirectory name during the build):
-
-   .. code-block:: shell
-
-      mv debianpkg debian
-      make -f debian/rules backports
-
-   This will create a :file:`frr_*.orig.tar.gz` with the source (same as the
-   dist tarball), as well as multiple :file:`frr_*.debian.tar.xz` and
-   :file:`frr_*.dsc` corresponding to each distribution for which a backport is
-   available.
-
-7. Create a new directory to build the package and populate with package
-   source.
-
-   .. code-block:: shell
-
-      mkdir frrpkg
-      cd frrpkg
-      tar xf ~/frr/frr_*.orig.tar.gz
-      cd frr*
-      . /etc/os-release
-      tar xf ~/frr/frr_*${ID}${VERSION_ID}*.debian.tar.xz
-
-8. Build Debian package dependencies and install them as needed.
-
-   .. code-block:: shell
-
-      sudo mk-build-deps --install debian/control
-
-9. Build Debian Package
+6. Build Debian Package
 
    Building with standard options:
 
@@ -101,80 +55,9 @@ Packaging Debian
 
       debuild -b -uc -us
 
-   Or change some options (see `rules` file for available options):
-
-   .. code-block:: shell
-
-      debuild --set-envvar=WANT_BGP_VNC=1 --set-envvar=WANT_CUMULUS_MODE=1 -b -uc -us
-
-   To build with RPKI:
-
-   - Download the librtr packages from
-     https://ci1.netdef.org/browse/RPKI-RTRLIB/latestSuccessful/artifact
-
-   - install librtr-dev on the build server
+7. Done!
 
-   Then build with:
-
-   .. code-block:: shell
-
-      debuild --set-envvar=WANT_RPKI=1 -b -uc -us
-
-   RPKI packages have an additonal dependency of ``librtr0`` which can be found
-   at the same URL.
-
-10. Done!
-
-If all worked correctly, then you should end up with the Debian packages under
-:file:`frrpkg`. If distributed, please make sure you distribute it together
-with the sources (``frr_*.orig.tar.gz``, ``frr_*.debian.tar.xz`` and
+If all worked correctly, then you should end up with the Debian packages in
+the parent directory.  If distributed, please make sure you distribute it
+together with the sources (``frr_*.orig.tar.gz``, ``frr_*.debian.tar.xz`` and
 ``frr_*.dsc``)
-
-The build procedure can also be executed automatically using the ``tools/build-debian-package.sh``
-script. For example:
-
-.. code-block:: shell
-
-   EXTRA_VERSION="-myversion" WANT_SNMP=1 WANT_CUMULUS_MODE=1 tools/build-debian-package.sh
-
-.. _deb-backports:
-
-Debian Backports
-----------------
-
-The :file:`debianpkg/backports` directory contains the Debian directories for
-backports to other Debian platforms.  These are built via the ``3.0 (custom)``
-source format, which allows one to build a source package directly out of
-tarballs (e.g. an orig.tar.gz tarball and a debian.tar.gz file), at which point
-the format can be changed to a real format (e.g. ``3.0 (quilt)``).
-
-Source packages are assembled via targets of the same name as the system to
-which the backport is done (e.g. ``precise``), included in :file:`debian/rules`.
-
-To create a new Debian backport:
-
-- Add its name to ``KNOWN_BACKPORTS``, defined in :file:`debian/rules`.
-- Create a directory of the same name in :file:`debian/backports`.
-- Add the files ``exclude``, ``versionext``, and ``debian/source/format`` under
-  this directory.
-
-For the last point, these files should contain the following:
-
-``exclude``
-   Contains whitespace-separated paths (relative to the root of the source dir)
-   that should be excluded from the source package (e.g.
-   :file:`debian/patches`).
-
-``versionext``
-   Contains the suffix added to the version number for this backport's build.
-   Distributions often have guidelines for what this should be. If left empty,
-   no new :file:`debian/changelog` entry is created.
-
-``debian/source/format``
-   Contains the source format of the resulting source package.  As of of the
-   writing of this document the only supported format is ``3.0 (quilt)``.
-
-- Add appropriate files under the :file:`debian/` subdirectory.  These will be
-  included in the source package, overriding any top-level :file:`debian/`
-  files with equivalent paths.
-
diff --git a/tools/tarsource.sh b/tools/tarsource.sh
index a40a597ba4..78efae3577 100755
--- a/tools/tarsource.sh
+++ b/tools/tarsource.sh
@@ -165,7 +165,7 @@ if test -d "$src/.git"; then
 	# if there have been changes to packaging or tests, it's still the
 	# same release
 	changes="`git diff --name-only "$gittag" $commit | \
-		egrep -v '\.git|^m4/|^config|^README|^alpine/|^debianpkg/|^pkgsrc/|^ports/|^redhat/|^snapcraft/|^solaris/|^tests/|^gdb/|^docker/|^\.' | \
+		egrep -v '\.git|^m4/|^config|^README|^alpine/|^debian/|^pkgsrc/|^ports/|^redhat/|^snapcraft/|^solaris/|^tests/|^tools/|^gdb/|^docker/|^\.' | \
 		wc -l`"
 	if test "$changes" -eq 0; then
 		adjchangelog=true
@@ -206,7 +206,7 @@ if test -d "$src/.git"; then
 		test $extraset = false -a -f "$tmpdir/.gitpr" && extraver="-PR`cat \"$tmpdir/.gitpr\"`$extraver"
 	fi
 
-	debsrc="( git ls-files debianpkg/; echo debianpkg/changelog )"
+	debsrc="git ls-files debian/"
 else
 	if $nongit; then
 		echo -e "\033[31;1mWARNING: this script should be executed from a git tree\033[m" >&2
@@ -214,7 +214,7 @@ else
 		echo -e "\033[31;1mERROR: this script should be executed from a git tree\033[m" >&2
 		exit 1
 	fi
-	debsrc="echo debianpkg"
+	debsrc="echo debian"
 fi
 
 if $writeversion; then
@@ -265,22 +265,21 @@ lsfiles="frr-${PACKAGE_VERSION}.tar.$zip"
 
 if $debian; then
 	mkdir -p "$tmpdir/debian/source"
-	cp debianpkg/changelog "$tmpdir/debian/changelog"
+	cat debian/changelog > "$tmpdir/debian/changelog"
 	if $adjchangelog; then
-		if grep -q 'autoconf changelog entry' debianpkg/changelog; then
-			tail -n +9 debianpkg/changelog > "$tmpdir/debian/changelog"
+		if grep -q 'autoconf changelog entry' debian/changelog; then
+			tail -n +9 debian/changelog > "$tmpdir/debian/changelog"
 		fi
 	fi
 	echo '3.0 (quilt)' > "$tmpdir/debian/source/format"
 	DEBVER="`dpkg-parsechangelog -l\"$tmpdir/debian/changelog\" -SVersion`"
 
-	# rename debianpkg to debian while tar'ing
 	eval $debsrc | tar -cho $taropt \
-		--exclude-vcs --exclude debianpkg/source/format \
-		--exclude debianpkg/changelog \
-		--exclude debianpkg/changelog.in \
-		--exclude debianpkg/subdir.am \
-		--transform 's%^debianpkg%debian%' \
+		--exclude-vcs --exclude debian/source/format \
+		--exclude debian/changelog \
+		--exclude debian/changelog-auto \
+		--exclude debian/changelog-auto.in \
+		--exclude debian/subdir.am \
 		-T - -f ../frr_${DEBVER}.debian.tar
 	# add specially prepared files from above
 	tar -uf ../frr_${DEBVER}.debian.tar $taropt -C "$tmpdir" debian/source/format debian/changelog
@@ -290,7 +289,7 @@ if $debian; then
 
 	# pack up debian files proper
 	ln -s "$outdir/frr-${PACKAGE_VERSION}.tar.$zip" ../frr_${PACKAGE_VERSION}.orig.tar.$zip
-	dpkg-source -l"$tmpdir/debian/changelog" -c"`pwd`/debianpkg/control" \
+	dpkg-source -l"$tmpdir/debian/changelog" \
 		--format='3.0 (custom)' --target-format='3.0 (quilt)' \
 		-b . frr_${PACKAGE_VERSION}.orig.tar.$zip frr_${DEBVER}.debian.tar.$zip