[PATCH v2] debian: Mitigate bulk of Lintian issues

[PATCH v2] debian: Mitigate bulk of Lintian issues

[Valters Jansons]

[-- Attachment #1: Type: text/plain, Size: 12494 bytes --]

- d/.gitignore: Ignore all temporary files and subdirectories such as
  debian/location-importer/ and debian/location-importer.debhelper.log
  with the exception of debian/source/ and potential debian/patches/
  which may be used for Quilt, considering the source format is set
  to '3.0 (quilt)'.

- d/clean: Remove m4/intltool.m4 and po/Makefile.in.in autogenerated
  files prior to building/in-between builds. Without removal of these
  autogenerated files, build tooling complains about unexpected changes
  to the source tree.

- d/control: Move libloc1 to 'libs' section
  (lintian: wrong-section-according-to-package-name).
- d/control: Set 'Multi-Arch: foreign' hint for location-importer and
  location-python, due to py3compile via dh-python
  (lintian: multi-arch-same-package-calls-pycompile).

- d/copyright: Update format link to use HTTPS instead of HTTP
  (lintian: insecure-copyright-format-uri).

- d/libloc1.symbols: Added symbols export file
  (lintian: no-symbols-control-file). For generation:
  $ debuild -uc -us # to easily build everything to debian/tmp/
  $ dpkg-gensymbols -plibloc1 -Odebian/libloc1.symbols
  $ sed -i -E -e 's/( [0-9\.]+)-.+$/\1/' debian/*.symbols

- d/location-python.examples: Add the examples/python/ to documentation
  (lintian: package-does-not-install-examples).

- d/rules: Remove _location.la from location-python package
  (lintian: unknown-file-in-python-module-directory,
  incorrect-libdir-in-la-file, non-empty-dependency_libs-in-la-file).
  Considering the dependency library is not being installed, the la
  file does not appear too useful. Additionally, dh-python moves the
  site-packages files dist-packages resulting in a broken libdir,
  and unexpected .la files being added to Python root.
- d/rules: Remove location/{database,importer}.py from location-python
  package. These files get installed to location-importer package
  (lintian: binaries-have-file-conflict).

- d/watch: Add uscan configuration, as expected for '3.0 (quilt)' format
  (lintian: debian-watch-file-is-missing).

- src/systemd/location-update.service.in: Add a generic Documentation=
  linking to the manual page of location, for `systemctl help <name>`
  (lintian: systemd-service-file-missing-documentation-key).

Following this, the only complaints from Lintian are about:
- `location-importer` not having a manpage.
- Short package Descriptions, not explaining what they do in detail.
- An out-dated Standards-Version.
- An old debhelper compatibility level.
- Lack of an autopkgtest testsuite.

Signed-off-by: Valters Jansons <valter.jansons(a)gmail.com>
---
 debian/.gitignore                      |   8 +-
 debian/clean                           |   2 +
 debian/control                         |   5 +-
 debian/copyright                       |   2 +-
 debian/libloc1.symbols                 | 134 +++++++++++++++++++++++++
 debian/location-python.examples        |   1 +
 debian/rules                           |   8 ++
 debian/watch                           |   3 +
 src/systemd/location-update.service.in |   1 +
 9 files changed, 157 insertions(+), 7 deletions(-)
 create mode 100644 debian/clean
 create mode 100644 debian/libloc1.symbols
 create mode 100644 debian/location-python.examples
 create mode 100644 debian/watch

diff --git a/debian/.gitignore b/debian/.gitignore
index 0faf920..4a7eb9a 100644
--- a/debian/.gitignore
+++ b/debian/.gitignore
@@ -2,9 +2,9 @@
 /autoreconf.*
 /debhelper-build-stamp
 /files
-/libloc/
-/libloc-dev/
-/libloc-perl/
-/tmp
+/*/
 *.debhelper
+*.log
 *.substvars
+!/patches/
+!/source/
diff --git a/debian/clean b/debian/clean
new file mode 100644
index 0000000..54a6877
--- /dev/null
+++ b/debian/clean
@@ -0,0 +1,2 @@
+m4/intltool.m4
+po/Makefile.in.in
diff --git a/debian/control b/debian/control
index dc40927..ec27f92 100644
--- a/debian/control
+++ b/debian/control
@@ -23,6 +23,7 @@ Vcs-Browser: https://git.ipfire.org/pub/git/location/libloc.git
 
 Package: libloc1
 Architecture: any
+Section: libs
 Pre-Depends:
  ${misc:Pre-Depends}
 Depends:
@@ -67,7 +68,7 @@ Depends:
  location-python (= ${binary:Version}),
  ${misc:Depends},
  ${python3:Depends}
-Multi-Arch: same
+Multi-Arch: foreign
 Description: Tools to author location databases
  This package contains tools that are required to build location databases
 
@@ -80,6 +81,6 @@ Depends:
  ${misc:Depends},
  ${python3:Depends},
  ${shlibs:Depends}
-Multi-Arch: same
+Multi-Arch: foreign
 Description: Python modules for libloc
  This package contains Python bindings for libloc
diff --git a/debian/copyright b/debian/copyright
index 636af48..3bd7654 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -1,4 +1,4 @@
-Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 Upstream-Name: libloc
 Upstream-Contact: Michael Tremer <michael.tremer(a)ipfire.org>
 Source: https://location.ipfire.org/download
diff --git a/debian/libloc1.symbols b/debian/libloc1.symbols
new file mode 100644
index 0000000..74b70b5
--- /dev/null
+++ b/debian/libloc1.symbols
@@ -0,0 +1,134 @@
+libloc.so.1 libloc1 #MINVER#
+* Build-Depends-Package: libloc-dev
+ LIBLOC_1(a)LIBLOC_1 0.9.4
+ LIBLOC_PRIVATE(a)LIBLOC_PRIVATE 0.9.4
+ loc_as_cmp(a)LIBLOC_1 0.9.4
+ loc_as_get_name(a)LIBLOC_1 0.9.4
+ loc_as_get_number(a)LIBLOC_1 0.9.4
+ loc_as_list_append(a)LIBLOC_1 0.9.5
+ loc_as_list_clear(a)LIBLOC_1 0.9.5
+ loc_as_list_contains(a)LIBLOC_1 0.9.5
+ loc_as_list_contains_number(a)LIBLOC_1 0.9.5
+ loc_as_list_empty(a)LIBLOC_1 0.9.5
+ loc_as_list_get(a)LIBLOC_1 0.9.5
+ loc_as_list_new(a)LIBLOC_1 0.9.5
+ loc_as_list_ref(a)LIBLOC_1 0.9.5
+ loc_as_list_size(a)LIBLOC_1 0.9.5
+ loc_as_list_unref(a)LIBLOC_1 0.9.5
+ loc_as_new(a)LIBLOC_1 0.9.4
+ loc_as_ref(a)LIBLOC_1 0.9.4
+ loc_as_set_name(a)LIBLOC_1 0.9.4
+ loc_as_unref(a)LIBLOC_1 0.9.4
+ loc_country_cmp(a)LIBLOC_1 0.9.4
+ loc_country_code_is_valid(a)LIBLOC_1 0.9.4
+ loc_country_get_code(a)LIBLOC_1 0.9.4
+ loc_country_get_continent_code(a)LIBLOC_1 0.9.4
+ loc_country_get_name(a)LIBLOC_1 0.9.4
+ loc_country_list_append(a)LIBLOC_1 0.9.5
+ loc_country_list_clear(a)LIBLOC_1 0.9.5
+ loc_country_list_contains(a)LIBLOC_1 0.9.5
+ loc_country_list_contains_code(a)LIBLOC_1 0.9.5
+ loc_country_list_empty(a)LIBLOC_1 0.9.5
+ loc_country_list_get(a)LIBLOC_1 0.9.5
+ loc_country_list_new(a)LIBLOC_1 0.9.5
+ loc_country_list_ref(a)LIBLOC_1 0.9.5
+ loc_country_list_size(a)LIBLOC_1 0.9.5
+ loc_country_list_unref(a)LIBLOC_1 0.9.5
+ loc_country_new(a)LIBLOC_1 0.9.4
+ loc_country_ref(a)LIBLOC_1 0.9.4
+ loc_country_set_continent_code(a)LIBLOC_1 0.9.4
+ loc_country_set_name(a)LIBLOC_1 0.9.4
+ loc_country_unref(a)LIBLOC_1 0.9.4
+ loc_database_count_as(a)LIBLOC_1 0.9.4
+ loc_database_created_at(a)LIBLOC_1 0.9.4
+ loc_database_enumerator_get_asns(a)LIBLOC_1 0.9.5
+ loc_database_enumerator_get_countries(a)LIBLOC_1 0.9.5
+ loc_database_enumerator_new(a)LIBLOC_1 0.9.4
+ loc_database_enumerator_next_as(a)LIBLOC_1 0.9.4
+ loc_database_enumerator_next_country(a)LIBLOC_1 0.9.4
+ loc_database_enumerator_next_network(a)LIBLOC_1 0.9.4
+ loc_database_enumerator_ref(a)LIBLOC_1 0.9.4
+ loc_database_enumerator_set_asns(a)LIBLOC_1 0.9.5
+ loc_database_enumerator_set_countries(a)LIBLOC_1 0.9.5
+ loc_database_enumerator_set_family(a)LIBLOC_1 0.9.4
+ loc_database_enumerator_set_flag(a)LIBLOC_1 0.9.4
+ loc_database_enumerator_set_string(a)LIBLOC_1 0.9.4
+ loc_database_enumerator_unref(a)LIBLOC_1 0.9.4
+ loc_database_get_as(a)LIBLOC_1 0.9.4
+ loc_database_get_country(a)LIBLOC_1 0.9.4
+ loc_database_get_description(a)LIBLOC_1 0.9.4
+ loc_database_get_license(a)LIBLOC_1 0.9.4
+ loc_database_get_vendor(a)LIBLOC_1 0.9.4
+ loc_database_lookup(a)LIBLOC_1 0.9.4
+ loc_database_lookup_from_string(a)LIBLOC_1 0.9.4
+ loc_database_new(a)LIBLOC_1 0.9.4
+ loc_database_ref(a)LIBLOC_1 0.9.4
+ loc_database_unref(a)LIBLOC_1 0.9.4
+ loc_database_verify(a)LIBLOC_1 0.9.4
+ loc_discover_latest_version(a)LIBLOC_1 0.9.4
+ loc_get_log_priority(a)LIBLOC_1 0.9.4
+ loc_network_address_family(a)LIBLOC_1 0.9.4
+ loc_network_cmp(a)LIBLOC_1 0.9.5
+ loc_network_exclude(a)LIBLOC_1 0.9.5
+ loc_network_exclude_list(a)LIBLOC_1 0.9.5
+ loc_network_format_first_address(a)LIBLOC_1 0.9.4
+ loc_network_format_last_address(a)LIBLOC_1 0.9.4
+ loc_network_get_asn(a)LIBLOC_1 0.9.4
+ loc_network_get_country_code(a)LIBLOC_1 0.9.4
+ loc_network_get_first_address(a)LIBLOC_1 0.9.5
+ loc_network_get_last_address(a)LIBLOC_1 0.9.5
+ loc_network_has_flag(a)LIBLOC_1 0.9.4
+ loc_network_is_subnet(a)LIBLOC_1 0.9.5
+ loc_network_list_clear(a)LIBLOC_1 0.9.5
+ loc_network_list_contains(a)LIBLOC_1 0.9.5
+ loc_network_list_dump(a)LIBLOC_1 0.9.5
+ loc_network_list_empty(a)LIBLOC_1 0.9.5
+ loc_network_list_get(a)LIBLOC_1 0.9.5
+ loc_network_list_merge(a)LIBLOC_1 0.9.5
+ loc_network_list_new(a)LIBLOC_1 0.9.5
+ loc_network_list_pop(a)LIBLOC_1 0.9.5
+ loc_network_list_pop_first(a)LIBLOC_1 0.9.5
+ loc_network_list_push(a)LIBLOC_1 0.9.5
+ loc_network_list_ref(a)LIBLOC_1 0.9.5
+ loc_network_list_size(a)LIBLOC_1 0.9.5
+ loc_network_list_unref(a)LIBLOC_1 0.9.5
+ loc_network_match_address(a)LIBLOC_1 0.9.5
+ loc_network_match_asn(a)LIBLOC_1 0.9.4
+ loc_network_match_country_code(a)LIBLOC_1 0.9.4
+ loc_network_match_flag(a)LIBLOC_1 0.9.4
+ loc_network_new(a)LIBLOC_1 0.9.4
+ loc_network_new_from_string(a)LIBLOC_1 0.9.4
+ loc_network_overlaps(a)LIBLOC_1 0.9.5
+ loc_network_prefix(a)LIBLOC_1 0.9.5
+ loc_network_ref(a)LIBLOC_1 0.9.4
+ loc_network_set_asn(a)LIBLOC_1 0.9.4
+ loc_network_set_country_code(a)LIBLOC_1 0.9.4
+ loc_network_set_flag(a)LIBLOC_1 0.9.4
+ loc_network_str(a)LIBLOC_1 0.9.4
+ loc_network_subnets(a)LIBLOC_1 0.9.5
+ loc_network_unref(a)LIBLOC_1 0.9.4
+ loc_new(a)LIBLOC_1 0.9.4
+ loc_ref(a)LIBLOC_1 0.9.4
+ loc_set_log_fn(a)LIBLOC_1 0.9.4
+ loc_set_log_priority(a)LIBLOC_1 0.9.4
+ loc_stringpool_add(a)LIBLOC_PRIVATE 0.9.4
+ loc_stringpool_dump(a)LIBLOC_PRIVATE 0.9.4
+ loc_stringpool_get(a)LIBLOC_PRIVATE 0.9.4
+ loc_stringpool_get_size(a)LIBLOC_PRIVATE 0.9.4
+ loc_stringpool_new(a)LIBLOC_PRIVATE 0.9.4
+ loc_stringpool_ref(a)LIBLOC_PRIVATE 0.9.4
+ loc_stringpool_unref(a)LIBLOC_PRIVATE 0.9.4
+ loc_unref(a)LIBLOC_1 0.9.4
+ loc_writer_add_as(a)LIBLOC_1 0.9.4
+ loc_writer_add_country(a)LIBLOC_1 0.9.4
+ loc_writer_add_network(a)LIBLOC_1 0.9.4
+ loc_writer_get_description(a)LIBLOC_1 0.9.4
+ loc_writer_get_license(a)LIBLOC_1 0.9.4
+ loc_writer_get_vendor(a)LIBLOC_1 0.9.4
+ loc_writer_new(a)LIBLOC_1 0.9.4
+ loc_writer_ref(a)LIBLOC_1 0.9.4
+ loc_writer_set_description(a)LIBLOC_1 0.9.4
+ loc_writer_set_license(a)LIBLOC_1 0.9.4
+ loc_writer_set_vendor(a)LIBLOC_1 0.9.4
+ loc_writer_unref(a)LIBLOC_1 0.9.4
+ loc_writer_write(a)LIBLOC_1 0.9.4
diff --git a/debian/location-python.examples b/debian/location-python.examples
new file mode 100644
index 0000000..cf2a6ee
--- /dev/null
+++ b/debian/location-python.examples
@@ -0,0 +1 @@
+examples/python/
diff --git a/debian/rules b/debian/rules
index 8893b7b..05b88fd 100755
--- a/debian/rules
+++ b/debian/rules
@@ -18,3 +18,11 @@ override_dh_perl:
 
 override_dh_systemd_enable:
 	dh_systemd_enable location-update.timer
+
+override_dh_install:
+	dh_install
+	# lintian: unknown-file-in-python-module-directory
+	rm debian/location-python/usr/lib/python3*/site-packages/_location.la
+	# linitan: binaries-have-file-conflict (d/location-importer.install)
+	rm debian/location-python/usr/lib/python3*/site-packages/location/database.py
+	rm debian/location-python/usr/lib/python3*/site-packages/location/importer.py
diff --git a/debian/watch b/debian/watch
new file mode 100644
index 0000000..19ace6d
--- /dev/null
+++ b/debian/watch
@@ -0,0 +1,3 @@
+version=4
+https://source.ipfire.org/releases/libloc/ \
+    @PACKAGE@@ANY_VERSION@@ARCHIVE_EXT@ debian uupdate
diff --git a/src/systemd/location-update.service.in b/src/systemd/location-update.service.in
index daae2c5..1c8e116 100644
--- a/src/systemd/location-update.service.in
+++ b/src/systemd/location-update.service.in
@@ -1,5 +1,6 @@
 [Unit]
 Description=Automatic Location Database Updater
+Documentation=man:location(8) https://man-pages.ipfire.org/libloc/location.html
 Requires=network.target
 
 [Service]
-- 
2.31.1