Package: rdtool
Version: 0.6.20-1+htmldoc
Severity: wishlist
Tags: patch
rdtool's own documentation (/usr/share/doc/rdtool/rd-draft.rd.gz) is
currently shipped in the 'rdtool' debian package only in .rd format.
This causes two problems:
1) reading the documentation is not very handy, especially when it comes
to comparing the markup needed to obtain a given visual effect with
the visual effect itself (since escaping is needed in the first case
and the use is probably reading a format she want to learn, hence a
format she is not familiar with)
2) the .rd extension is not considered as an exception by dh_compress
and hence is even shipped compressed (as .rd.gz) and hence not
directly suitable for digestion by rdtool itself (i.e. "rd2
/usr/share/doc/rdtool/rd-draft.rd.gz" wont work)
I propose to ship the HTML version of the same document, as it's already
done for the README of rdtool.
The attached patch implements this request in the current version of the
debian package, please consider applying it.
Cheers.
-- System Information:
Debian Release: 4.0
APT prefers unstable
APT policy: (500, 'unstable'), (500, 'testing')
Architecture: i386 (i686)
Shell: /bin/sh linked to /bin/bash
Kernel: Linux 2.6.18-3-686
Locale: LANG=it_IT.UTF-8, LC_CTYPE=it_IT.UTF-8 (charmap=UTF-8)
Versions of packages rdtool depends on:
ii librd-ruby1.8 0.6.20-1+htmldoc RDTool library for Ruby 1.8
ii ruby1.8 1.8.5-4 Interpreter of object-oriented scr
rdtool recommends no packages.
-- no debconf information
diff -Nru /tmp/1m7UdUQpmq/rdtool-0.6.20/debian/changelog
/tmp/CksjYw7v0A/rdtool-0.6.20/debian/changelog
--- /tmp/1m7UdUQpmq/rdtool-0.6.20/debian/changelog 2007-01-21
12:00:02.000000000 +0100
+++ /tmp/CksjYw7v0A/rdtool-0.6.20/debian/changelog 2007-01-21
12:00:03.000000000 +0100
@@ -1,3 +1,9 @@
+rdtool (0.6.20-1+htmldoc) unstable; urgency=low
+
+ * ship HTML version of the rd documentation
+
+ -- Stefano Zacchiroli <[EMAIL PROTECTED]> Sun, 21 Jan 2007 11:51:18 +0100
+
rdtool (0.6.20-1) unstable; urgency=low
* New upstream release
diff -Nru /tmp/1m7UdUQpmq/rdtool-0.6.20/debian/docs
/tmp/CksjYw7v0A/rdtool-0.6.20/debian/docs
--- /tmp/1m7UdUQpmq/rdtool-0.6.20/debian/docs 2007-01-21 12:00:02.000000000
+0100
+++ /tmp/CksjYw7v0A/rdtool-0.6.20/debian/docs 2007-01-21 12:00:03.000000000
+0100
@@ -2,5 +2,6 @@
README.rd
README.rd.ja
README.html
+doc/rd-draft.html
doc/rd-draft.rd
doc/rd-draft.rd.ja
diff -Nru /tmp/1m7UdUQpmq/rdtool-0.6.20/debian/rules
/tmp/CksjYw7v0A/rdtool-0.6.20/debian/rules
--- /tmp/1m7UdUQpmq/rdtool-0.6.20/debian/rules 2007-01-21 12:00:02.000000000
+0100
+++ /tmp/CksjYw7v0A/rdtool-0.6.20/debian/rules 2007-01-21 12:00:03.000000000
+0100
@@ -26,6 +26,8 @@
$(ruby) -Ilib bin/rd2 -rrd/rd2man-lib -oRD2 bin/rd2
mv RD2.1 debian/rd2.1
+ bin/rd2 doc/rd-draft.rd > doc/rd-draft.html
+
touch build-stamp
clean:
@@ -34,6 +36,7 @@
rm -f build-stamp
-rm -f debian/rd2.1
-rm -f debian/rmi2html.rb.1
+ -rm -f doc/rd-draft.html
# Add here commands to clean up after the build process.
-$(ruby) setup.rb clean
