On Sun, Feb 17, 2008 at 11:27:50AM +0100, Robert Luberda wrote:
> Steve M. Robbins writes:

> That's why doc-base implemented the section mapping, which already  
> reduced a mass we have in doc-base sections. At the last paragraph, you  
> wrote that  this can't be done fully automatically, and I agree with  
> this - each maintainer should probably review their doc-base file  
> against the new sections list.

Another thought occurs to me: this change must really be well
communicated before the fact.  If I'm a maintainer trying to find the
docs, the first place I'm going to look is the section I specified in
the doc-base file.  If doc-base moves it behind my back, it's going to
make for a frustrating debugging session.

I would go so far as to suggest that you mail to
[EMAIL PROTECTED] for each $package that is going to get
mapped.  Probably best to bring this up on debian-devel first, come to
a consensus, then announce it on debian-devel-announce as well as to
the package maintainers affected.


>> Perhaps a gradual approach is best.  For example, start
>> with documenting the preferred first- and second-level sections.  This
>> addresses the proximal cause of me filing this bug: package
>> apt-dpkg-ref is in section Doc rather than Debian mainly because the
>> documentation for doc-base doesn't describe Section Debian (#153404).
>
> Yeah, but the Doc section wasn't described either.

True, and the apt-dpkg-ref maintainer hasn't responded since I
reopened the bug with that observation.  :-)


>> violators of the preferred sections.  In my mind, these are the
>> generics (principle #2): Docs, Doc, Misc, Tools, Utilities, Utils, and
>> Viewers. 
>
> The sections won't be included in the doc-base manual, except for  
> Viewers, which is also in menu hierarchy. However they will stay in the  
> mapping file only because it's impossible to do sensible automatic 
> mapping.

I ordered the principles by (my subjective opinion of) precedence.
Section Viewers violates principle #2 so it must be changed even if it
satisfies principle #4.  YMMV  :-)

Cheers,
-Steve

Attachment: signature.asc
Description: Digital signature

Reply via email to