Bug#363139: gtk: Please move all gtk html documentation to /usr/share/doc/...

[Loïc Minier]

        Hi,

On Sun, Dec 04, 2005, Justin Pryzby wrote:
> Is there any reason not to put everything from
> /usr/share/gtk-doc/html/X into the relevant place in
> /usr/share/doc/X/html/ ?

 Actually, I'm not 100% sure I agree with the rationale behind moving
 doc to /usr/share/doc/$package and would like to discuss it.

 Here all my ideas on the subject piled together:

 1) We do want to see all documentations relevant to a package below
 /usr/share/doc/$package, but this can easily be achieved via symlinks
 to the actual location of the documentation.

 2) /usr/share/gtk-doc/html seems like a FHS-compliant location to put
 all HTML documentation handled / generated by gtk-doc.

 3) How does this differ from man pages, .desktop files, doc-base files,
 etc?  These are directly below the place where they are expected, not
 below a per-package specific dir, such as /usr/share/$package/desktop.

 4) What if the documentation is relevant to multiple packages?  It's
 easy to have multiple links to /usr/share/gtk-doc/html from the
 /usr/share/doc/$package dirs.

 5) This breaks expectations across distributions that you can find the
 gtk-doc of foobar below /usr/share/gtk-doc/html/foobar unless we manage
 symlinks there.

 Summing this up, I propose the following:
 - continue shipping doc to /usr/share/gtk-doc/html as the default place
   for all gtk-doc HTML documentations (imagine someone writes
   gtk-doc-genindex)
 - symlink from all relevant /usr/share/doc/$package dirs to these docs.

 Is this acceptable?

   Bye,
-- 
Loïc Minier <lool at dooz.org>