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

Re: Bug#945269: debian-policy: packages should use tmpfiles.d(5) to create directories below /var



Some grammer thoughts. Especially i suggest avoiding the word
'integrate' wherever possible

Luca Boccassi <bluca@debian.org> writes:

> +Service Directories

> +
> +Init systems other than ``systemd`` should allow providing the same

"allow providing" should be "provide" (or "support"? or "allow [who] to
[do what]").

> +functionality as appropriate for each system, for example managing the
> +directories from the appropriate service startup configuration.
> +

does the first "system" mean "installation", "service" or is this "init
system"?


> +``tmpfiles.d`` snippets should be integrated in packages using
> automated shared

does "integrated in packages" mean "provided by packages"? (or "shipped"
is used below, but that is also jargony)

> +tooling rather than by manually writing package-specific code in maintainers
> +scripts. For example, packages built using ``debhelper`` should make use of the
> +``dh_installtmpfiles`` addon.

Could be more direct, eg "packages should create ``tmpfiles.d`` snippets
using existing tooling instead of writing bespoke code in maintainer
scripts. For example, packages that use ``debhelper`` should use
``dh_installtmpfiles``."


> +Init systems are required to integrate with ``tmpfiles.d`` and run
> the service

does this use of "integrate" mean "support" (or "implement something
equivalent to"?)

(And - is this sentence a set of requirements for init systems rather
than an individual package?  - if so, it might be better in a separate
subsection as would have different audience.)

> +that applies them on boot, and regularly for cleanup purposes, depending on the
> +appropriate package providing the appropriate implementation that best
> +integrates with each system.

i didnt understand this part - i wonder if this is trying to say several
requirements in one sentence: the init system needs to provide an
implementation of tmpfiles; the init system needs to run it on boot; the
init system needs to do 'cleanup' (of what?). 

> For example, ``systemd`` will make the reference
> +implementation available when its main package is installed. The documentation
> +for the reference implementation, `systemd-tmpfiles,
> +<https://www.freedesktop.org/software/systemd/man/systemd-tmpfiles.html>`_
> +explains how to call the program so that the appropriate ``tmpfiles.d`` snippets
> +are applied at the appropriate time.
> +

i got lost reading this bitwq, wasnt sure quite what "the program" and
"the reference implemetation" referring to here? and "the appropriate
time" maybe needs some more explanation.

> --- a/policy/ch-maintainerscripts.rst
> +++ b/policy/ch-maintainerscripts.rst


> +Instead, :ref:`s-tmpfiles.d` snippets should be shipped, with the ones provided
> +by the upstream sources, if any, to be preferred over Debian-specific ones when
> +possible.

does "with" mean "instead of" or "as well as" here?


Reply to: