On Thu, 2012-06-14 at 19:12:28 +0200, Axel Beckert wrote:
> On Wed, Jun 06, 2012 at 08:57:18AM +0200, Guillem Jover wrote:
> > > The manpage of dh_installdeb mentions the package.maintscript file to 
> > > install
> > > dpkg-maintscript-helper commands in maintainer scripts. This feature isn't
> > > mentioned in the dpkg-maintscript-helper manpage. It would be nice to 
> > > have a
> > > pointer there as well.
> > 
> > This is a helper specific file, and as such does not really belong in
> > the dpkg documentation, as that'd be a layer violation.
> 
> So what? Is that important?

Yes, it is.

> Documentation is there to help users, not to care about layers.

I'll not deny adding something like that might be helpful for some
users, otherwise I guess the bug report would not have been filed!

> I would have spared myself quite some work implementing such a feature
> for one of my packages if dpkg-maintscript-helper(1) would have had
> such a cross-reference to dh_installdeb(1), e.g. in the SEE ALSO
> section (which never cared about any layers).

> > There's lots of helper tools that would need adding all over the
> > dpkg documentation, not just this one reference. I'm thus closing
> > this.
> 
> :-(

The point is that if you are using a helper you should first be
checking its documentation. Adding references to all possible users
of the tools does not scale. In this case this would have required
adding references to lots of debhelper programs, some CDBS stuff,
yada (but then now that would need to be cleaned up), etc to dpkg's
documentation; and by the same logic adding in the debhelper's
documentation references to CDBS stuff, or references to 3rd party
debhelper modules like dh-buildinfo. I don't think Joey would be
really thrilled about that either.

regards,
guillem



-- 
To UNSUBSCRIBE, email to debian-dpkg-bugs-requ...@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org

Reply via email to