[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Which directory to use for packagename-doc documentation files?



Steve Greenland wrote:

> On 23-Jul-01, 09:35 (CDT), Peter S Galbraith <GalbraithP@dfo-mpo.gc.ca> wrote
> : 
> > [Some foo-doc packages put the docs /usr/share/doc/foo, others
> >  in /usr/share/doc/foo-doc.]
> > 
> > Is that correct?
> > Should we use directory /usr/share/doc/foo ?
> 
> There's no stated policy. It's been annoying me for a long time,
> I'm glad you brought it up. The discussion probably belongs in
> debian-policy.
> 
> Steve

I guess I was trying to convince myself it was the best thing to
do (after the overwhelming response, I decided to just do that on
my package :-)

Had we establish a consensus on -devel, I would have formulated a
proposal for -policy.

Here's what I think:

- When source package `foo' creates binary packages `foo' and
  `foo-doc', there's no reason not to put foo-doc's documentation
  files under /usr/share/doc/foo/.  Just say where they are in
  /usr/share/doc/foo-doc/README.Debian

- If source package `foo-doc' (creating binary-all package foo-doc)
  documents source package `foo' (which creates simply binary-arch
  package foo, or alternatively foo-bin + foo-bin2), then it might be
  best to leave documentation files under /usr/share/doc/foo-doc/.  This
  makes it more obvious that foo-doc may document a different version of
  foo than is installed on the system.

My two cents.  Enough for policy?  Probably not.

Peter



Reply to: