Bug#582109: debian-policy: document triggers where appropriate
On Sat, 2013-03-02 at 18:45:30 +0900, Charles Plessy wrote:
> Le Sun, Feb 24, 2013 at 04:41:55PM +0900, Charles Plessy a écrit :
> > I am having a look at how to document triggers. In order to simplify the
> > explanation and re-use more easily material from the file above, I think
> > that we would benefit from documenting the dpkg states for a package.
This is documented in the dpkg man page (PACKAGE STATES), sorry for
not mentioning this before.
> How about adding the following to the Policy's section 6.1 (Introduction to
> package maintainer scripts) ?
We unified the states in policy to be all capitalized some time ago,
I think it would make sense to follow that convention to not confuse
the terminology usage.
> Dpkg defines the folowing states for the packages.
> The package is not installed or has been purged.
I'm not sure, if we should mention how to transition from/to states in
this description, doing that in a dedicated section on how those
transitions happen might be better (this re to the “has been purged”).
> The package has been removed; its configuration files remain.
Related to state transitions, I'd talk about the current state (is) not
how we got there (has been), here and in all other state descriptions.
> Errors happened during installation, upgrade or removal. Solving
> them requires the package to be re-installed.
... or removed. Same comment about state transitions.
> The files contained in the package have been successfuly unpacked,
> but the maintainer scripts have not been executed. Thus, the
> files created by the maintainer scripts are not yet available.
Configuration might involve changing existing files, or changing
parameters through existing APIs that change, say, a database on the
backend for example, so I'd avoid explicitly mentioning that files
might not be available, as that's not really comprehensive.
> The package has been unpacked, and an error occured during the
> execution of one of its maintainer scripts.
Same comment about state transitions. This state could also happen during
removal for example.
> The package has been unpacked and configured, and its
> installation activated some <prgn>dpkg</prgn> triggers that have
> not yet been executed.
I'd say that the triggers need to be processed, and not executed. Also
do we need to say that those are dpkg triggers, I'd say they are just
> Some triggers handled by this package have been activated and are
> not yet executed.
Same comment about executed → processed.
> The package is installed, no further action is required.
The “no further action is required” seems a bit confusing, to me it
reads as there's nothing else to be done to the package ever again,
not even upgrades or removals. :)
Hope that helps.