Package: urlscan
Version: 0.9.9-1
Severity: minor
Tags: patch upstream
The man page in this page lists the readme in the 'See Also' section.
But the filename is wrong.
In v0.9.9-1 the man page says:
/usr/share/doc/urlscan/README
and the file installed is
/usr/share/doc/urlscan/README.md.gz
This was wrong in 0.8.2-1 too
man page still said:
/usr/share/doc/urlscan/README
but the file installed was:
/usr/share/doc/urlscan/README.rst
Obviously this isn't a huge deal, but it is annoying to copy-paste the
filename and just get an error, then have to investigate. Making them
match up would be good.
Personally I don't like the way debian gzips small READMEs by default.
'more /usr/share/doc/urlscan/README.md.gz' produces garbage.
less and most work, but is saving 4K really worth it here (the
original is 7K)?
So I'd change the manpage to say
/usr/share/doc/urlscan/README.md
and prevent the autogzipping.
(patch for this attached)
But you could just change the manpage to match the filename with the
.gz if you prefer.
The bit about changing the name (but not the bit about non gzipping)
should go upstream as this is an upstream issue.
Hope that's helpful.
Wookey
diff -Nru urlscan-0.9.9/debian/changelog urlscan-0.9.9/debian/changelog
--- urlscan-0.9.9/debian/changelog 2022-06-06 22:28:24.000000000 +0100
+++ urlscan-0.9.9/debian/changelog 2024-01-24 17:12:55.000000000 +0000
@@ -1,3 +1,10 @@
+urlscan (0.9.9-1.1) unstable; urgency=medium
+
+ * Non-maintainer upload.
+ * Correct README filename in manpage
+
+ -- Wookey <woo...@debian.org> Wed, 24 Jan 2024 17:12:55 +0000
+
urlscan (0.9.9-1) unstable; urgency=medium
* New upstream version 0.9.9 (Closes: #999338)
diff -Nru urlscan-0.9.9/debian/patches/fixup-README-filename.patch
urlscan-0.9.9/debian/patches/fixup-README-filename.patch
--- urlscan-0.9.9/debian/patches/fixup-README-filename.patch 1970-01-01
01:00:00.000000000 +0100
+++ urlscan-0.9.9/debian/patches/fixup-README-filename.patch 2024-01-24
17:12:55.000000000 +0000
@@ -0,0 +1,13 @@
+Index: urlscan-0.9.9/urlscan.1
+===================================================================
+--- urlscan-0.9.9.orig/urlscan.1
++++ urlscan-0.9.9/urlscan.1
+@@ -213,7 +213,7 @@ $HOME/.config/urlscan/config.json
+ Only required if additional or modified palettes or keybindings are desired.
+
+ .SH SEE ALSO
+-\fI/usr/share/doc/urlscan/README\fR,
++\fI/usr/share/doc/urlscan/README.md\fR,
+ \fBurlview\fR(1),
+ \fBmutt\fR(1)
+
diff -Nru urlscan-0.9.9/debian/patches/series
urlscan-0.9.9/debian/patches/series
--- urlscan-0.9.9/debian/patches/series 2022-06-06 22:28:24.000000000 +0100
+++ urlscan-0.9.9/debian/patches/series 2024-01-24 17:12:55.000000000 +0000
@@ -1,1 +1,2 @@
0001-Source-patch-removing-from-binary-package-not-needed.patch
+fixup-README-filename.patch
diff -Nru urlscan-0.9.9/debian/rules urlscan-0.9.9/debian/rules
--- urlscan-0.9.9/debian/rules 2022-06-06 22:28:24.000000000 +0100
+++ urlscan-0.9.9/debian/rules 2024-01-24 17:12:55.000000000 +0000
@@ -5,3 +5,6 @@
override_dh_python3:
dh_python3 --shebang='/usr/bin/python3'
+
+override_dh_compress:
+ dh_compress --exclude README.md
