Bug#519717: remove deb-triggers(5); make dpkg-trigger(1) refer to spec

2009-03-15 Thread Raphael Hertzog
On Sat, 14 Mar 2009, Ian Jackson wrote:
 Package: dpkg
 Version: 1.15.0
 
 /usr/share/man/man5/deb-triggers.5.gz has just come to my attention.
 I can see why someone wanted to add it but I think the inclusion of
 this file in this form was a mistake.

deb-*(5) document file formats of files inside the .deb control archive. I
don't see a valid reason to remove deb-triggers(5) given that packages can
have a triggers file in their control archive.

 The dpkg trigger machinery is useful only to package maintainers.  The
 concepts on which deb-triggers(5) and dpkg-trigger(1) depend are those
 of the dpkg trigger system as defined in the specification.
 
 I can see that there is an argument that /usr/bin/dpkg-trigger is
 useful to a sysadmin (but arguably the manpage should be in section
 8), and thus having it documented in the form of a manpage is useful.

It's in /usr/bin so section 1 is not that much of a problem.

 But it is essential that the manpage give a reference to the full
 specification.

That can be done of course. I'll do it right now.

 (One might also consider whether the material which is currently
 duplicated between triggers.txt.gz and dpkg-trigger(1) should appear
 in only one place; removing the usage information from triggers.txt.gz
 should be done insofar as it would make that document clearer.)

Patch welcome. In the mean time it doesn't hurt as long as the infos don't
contradict themselves.

Cheers,
-- 
Raphaël Hertzog

Contribuez à Debian et gagnez un cahier de l'admin Debian Lenny :
http://www.ouaza.com/wp/2009/03/02/contribuer-a-debian-gagner-un-livre/



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



Bug#519717: remove deb-triggers(5); make dpkg-trigger(1) refer to spec

2009-03-14 Thread Ian Jackson
Package: dpkg
Version: 1.15.0

/usr/share/man/man5/deb-triggers.5.gz has just come to my attention.
I can see why someone wanted to add it but I think the inclusion of
this file in this form was a mistake.

If everything about the triggers machinery was done in manpages then
absolutely, there should be a deb-triggers(5) and a deb-triggers(7)
and so forth.  But the documentation for triggers is in
triggers.txt.gz.

The dpkg trigger machinery is useful only to package maintainers.  The
concepts on which deb-triggers(5) and dpkg-trigger(1) depend are those
of the dpkg trigger system as defined in the specification.

I can see that there is an argument that /usr/bin/dpkg-trigger is
useful to a sysadmin (but arguably the manpage should be in section
8), and thus having it documented in the form of a manpage is useful.
But it is essential that the manpage give a reference to the full
specification.

(One might also consider whether the material which is currently
duplicated between triggers.txt.gz and dpkg-trigger(1) should appear
in only one place; removing the usage information from triggers.txt.gz
should be done insofar as it would make that document clearer.)

As for deb-triggers(5), I'm afraid that I think it should be removed.
It is just a red herring.

Ian.



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