Package: git-buildpackage
Version: 0.9.38
Severity: wishlist
Dear Maintainer,
I was experimenting with devhelp for reading and searching documentation
locally and I discovered that though git-buildpackage does include an index
file for devhelp, devhelp can't find the documentation.
The devhelp2 file that's is created by git-buildpackage's documentation build
process gets installed as
/usr/share/doc/git-buildpackage/manual-html/book.devhelp2
and as far as I can tell to get devhelp to load documentation it needs a link
to the html documention in /usr/share/devhelp/books pointing to the html
directory containing a devhelp2 index with the same name as the link.
So to get the git-buildpackage documentation to appear I think the current file
book.devhelp2 should be called git-buildpackage.devhelp2, and a symlink should
be added from /usr/share/devhelp/books/git-buildpackage pointing at
/usr/share/doc/git-buildpackage/manual-html.
I think the reason the devhelp2 file is getting created is as a side effect of
using gtk-doc. Attached is a small patch against 0.9.38 that tells gtk-doc to
name the package, and adds the symlink so the git-buildpackage manual show up
in devhelp as "Building Debian Packages with git-buildpackage".
Diane
-- System Information:
Debian Release: trixie/sid
APT prefers stable-updates
APT policy: (500, 'stable-updates'), (500, 'stable-security'), (500,
'testing'), (500, 'stable'), (110, 'unstable')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.21-amd64 (SMP w/22 CPU threads; PREEMPT)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8),
LANGUAGE=en_US:en
Shell: /bin/sh linked to /usr/bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled
Versions of packages git-buildpackage depends on:
ii devscripts 2.25.10
ii git 1:2.47.2-0.1
ii man-db 2.13.0-1
ii python3 3.13.2-2
ii python3-dateutil 2.9.0-4
ii python3-yaml 6.0.2-1+b2
ii sensible-utils 0.0.24
Versions of packages git-buildpackage recommends:
ii pristine-tar 1.50+nmu2
ii python3-requests 2.32.3+dfsg-5
ii sbuild 0.89.0
Versions of packages git-buildpackage suggests:
pn python3-notify2 <none>
ii sudo 1.9.16p2-1
ii unzip 6.0-29
-- no debconf information
diff --git a/debian/git-buildpackage.links b/debian/git-buildpackage.links
index 1e696e39..67d0679f 100644
--- a/debian/git-buildpackage.links
+++ b/debian/git-buildpackage.links
@@ -1,2 +1,3 @@
/usr/share/man/man1/gbp.1.gz /usr/share/man/man1/git-buildpackage.1.gz
/usr/lib/python3/dist-packages/gbp/scripts/supercommand.py /usr/bin/gbp
+/usr/share/doc/git-buildpackage/manual-html/
/usr/share/devhelp/books/git-buildpackage
diff --git a/docs/Makefile b/docs/Makefile
index f93d24fb..857d6fda 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -64,7 +64,7 @@ manual: $(MANUAL)/index.html $(DEST_IMAGES) css
$(MANUAL)/index.html: manual.xml chapters/*.xml manpages/*.xml common.ent
$(VERSION_ENT)
mkdir -p $(MANUAL)
- xsltproc -o $(MANUAL)/ /usr/share/gtk-doc/data/gtk-doc.xsl $<
+ xsltproc --stringparam gtkdoc.bookname "git-buildpackage" -o $(MANUAL)/
/usr/share/gtk-doc/data/gtk-doc.xsl $<
cp /usr/share/gtk-doc/data/*.png \
/usr/share/gtk-doc/data/*.css \
$(MANUAL)
