Andreas Metzler <[EMAIL PROTECTED]> writes:

> On 2006-05-30 Simon Josefsson <[EMAIL PROTECTED]> wrote:
>> Simon Josefsson <[EMAIL PROTECTED]> writes:
>> >> http://downhill.aus.cc/debian/misc/gnutls13_1.4.0-0.2.diff.gz
>
>>> Seems good to me.
>
>> I spoke too soon.  I've found a minor problem with the GTK-DOC stuff:
>
>> --- gnutls13-1.4.0.orig/debian/gnutls-doc.install
>> +++ gnutls13-1.4.0/debian/gnutls-doc.install
>> @@ -0,0 +1,4 @@
>> +doc/reference/html/*html usr/share/doc/gnutls-doc/api-reference
>> +doc/reference/html/*png usr/share/doc/gnutls-doc/api-reference
>
>> I believe GTK-DOC files should be placed in
>> /usr/share/gtk-doc/html/gnutls/, to be found by the various GTK-DOC
>> browsers.
>
> I am not familiar with gtk-doc, I thought this was just regular html
> documentation, which should be readable with any browser (and findable
> in the usual location). Am I wrong?

No, what you say is correct.

However, some GTK-DOC tools are looking for GTK-DOC-generated
documents in /usr/share/gtk-doc/, here's what's on my system:

drwxr-xr-x 2 root root 4096 2006-05-10 17:44 atk
drwxr-xr-x 2 root root 4096 2006-04-17 17:32 bonobo-activation
lrwxrwxrwx 1 root root   27 2006-04-17 17:35 gdk -> ../../doc/libgtk2.0-doc/gdk
lrwxrwxrwx 1 root root   34 2006-04-17 17:35 gdk-pixbuf -> 
../../doc/libgtk2.0-doc/gdk-pixbuf
lrwxrwxrwx 1 root root   29 2006-04-19 12:10 glib -> 
../../doc/libglib2.0-doc/glib
drwxr-xr-x 2 root root 4096 2006-05-16 20:14 gmime
lrwxrwxrwx 1 root root   34 2006-05-30 10:05 gnome-vfs-2.0 -> 
../../doc/libgnomevfs2-common/html
lrwxrwxrwx 1 root root   32 2006-04-19 12:10 gobject -> 
../../doc/libglib2.0-doc/gobject
lrwxrwxrwx 1 root root   27 2006-04-17 17:35 gtk -> ../../doc/libgtk2.0-doc/gtk
lrwxrwxrwx 1 root root   31 2006-04-17 17:35 gtk-faq -> 
../../doc/libgtk2.0-doc/gtk-faq
lrwxrwxrwx 1 root root   36 2006-04-17 17:35 gtk-tutorial -> 
../../doc/libgtk2.0-doc/gtk-tutorial
drwxr-xr-x 2 root root 4096 2006-04-17 17:32 libbonobo

As you can see, some packages put the GTK-DOC files directly under
/usr/share/gtk-doc/html/PKG, and some put them under
/usr/share/doc/PKG and a link in the former place.  I don't know if
there is a standard for this...

I guess adding a symlink in /usr/share/gtk-doc/html/gnutls that points
to /usr/share/doc/gnutls-doc/api-reference/ is the simplest.

> [...]
>> The shishi-doc.doc-base contains:
>
>> Format: HTML
>> Index: /usr/share/doc/shishi-doc/shishi.html
>> Files: /usr/share/doc/shishi-doc/*.html
>
>> Format: HTML
>> Index: /usr/share/gtk-doc/html/shishi/index.html
>> Files: /usr/share/gtk-doc/html/shishi/*
>
>> But I'm not sure if that is permitted.  I don't know the doc-base
>> design...  Nothing seem to be complaining though.
>
> Listing multiple documents does not work, only one of the entries will
> end up installed (take a look at /usr/share/doc-base) and listed in
> the maintainerscripts afaik.
>
> dh_installdocs(1):
> | If your package needs to register more than one document, you need
> | multiple files. To accomplish this, you can use files named
> | debian/package.doc-base.*

Ah, thanks!  I'll fix my shishi package.  A lintian test would have
been useful...

/Simon


-- 
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]

Reply via email to