mirror of
https://github.com/troglobit/finit.git
synced 2026-10-28 12:30:44 +00:00
doc: document command candidates and the duplicate title rule
The migration guide covered a stanza at a time, which is the wrong
shape for the two idioms that repeated a whole stanza. One of them,
several candidate binaries for one service, is now a command list.
The other, one service gated differently per platform, has no block
equivalent: those blocks share an identity because they share the
barrier condition downstream services wait for, so they cannot be
given separate titles. For that one the guide says to split the
variants across files, or leave that file in the line-based format,
which Finit still reads.
The udevd example in services.md taught the merge-broken form, and
system/10-hotplug.conf.in pointed readers at it for their syslogd.
Also lists libConfuse among the build dependencies. It has been
mandatory since the new .conf format landed, and build.md still said
two libraries. And corrects the note on variable expansion: it is
${VAR} that libconfuse expands when the file is read, with
${VAR:-default} supported. A plain $VAR reaches the service, which is
what makes `command = "syslogd -F $SYSLOGD_ARGS"` work with envfile.
Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
This commit is contained in:
1 parent
cfae4a0e10
commit
4299ce8839
6 files changed
+147
-14
No files matched your search
+62
-2
@@ -82,6 +82,63 @@ Service options
|
||||
| `nowarn` | leading `-` on `command` or `envfile` |
|
||||
| `restarttmo:` | dropped, was already an alias for `restart_sec:` |
|
||||
|
||||
Repeated stanzas
|
||||
----------------
|
||||
|
||||
The line-based format has no titles, so the same service could be
|
||||
declared more than once and Finit would sort out which line applied.
|
||||
A block title *is* the identity, and two blocks sharing one in the
|
||||
same file are rejected. The two shapes that relied on the repetition
|
||||
convert differently.
|
||||
|
||||
**Several candidate binaries for one service.** The daemon is known
|
||||
under more than one name and the stanzas were repeated once per name,
|
||||
each with `nowarn` so the ones that were not installed were skipped:
|
||||
|
||||
service nowarn pid:!/run/udevd.pid [S12345789] /lib/systemd/systemd-udevd -- Device event daemon
|
||||
service nowarn pid:!/run/udevd.pid [S12345789] udevd -- Device event daemon
|
||||
|
||||
The candidates now go in one block, and Finit starts the first one it
|
||||
finds:
|
||||
|
||||
service udevd {
|
||||
description = "Device event daemon"
|
||||
runlevel = "S12345789"
|
||||
pidfile = "/run/udevd.pid"
|
||||
command = { "/lib/systemd/systemd-udevd", "-udevd" }
|
||||
}
|
||||
|
||||
**One service gated differently per platform.** The command is the
|
||||
same every time, only `if:` and the conditions differ, e.g. a syslog
|
||||
daemon that has to wait for whichever hotplug daemon the system has:
|
||||
|
||||
service if:udevd nowarn env:-/etc/default/sysklogd <run/udevadm:5/success> \
|
||||
[S0123456789] syslogd -F $SYSLOGD_ARGS -- System log daemon
|
||||
service if:mdev nowarn env:-/etc/default/sysklogd <run/coldplug/success> \
|
||||
[S0123456789] syslogd -F $SYSLOGD_ARGS -- System log daemon
|
||||
|
||||
All of these are one service, `syslogd`, providing one `pid/syslogd`
|
||||
barrier for everything downstream, so they cannot be given separate
|
||||
titles without renaming that barrier. There are two ways to keep the
|
||||
identity:
|
||||
|
||||
* put each variant in its own .conf file, since the ban on duplicate
|
||||
titles is per file, or
|
||||
* leave this one file in the line-based format, which Finit still
|
||||
reads. Format is detected per file, so the rest of the system can
|
||||
be block format.
|
||||
|
||||
A single variant converts the way anything else does:
|
||||
|
||||
service syslogd {
|
||||
description = "System log daemon"
|
||||
runlevel = "S0123456789"
|
||||
if = "udevd"
|
||||
conditions = { "run/udevadm:5/success" }
|
||||
envfile = "-/etc/default/sysklogd"
|
||||
command = "-syslogd -F $SYSLOGD_ARGS"
|
||||
}
|
||||
|
||||
Cgroups
|
||||
-------
|
||||
|
||||
@@ -170,8 +227,11 @@ Worth knowing
|
||||
exactly like its legacy counterpart.
|
||||
* A list cannot hold comments; the lexer reads entries after a `#`
|
||||
regardless. Put commented-out candidates above the list.
|
||||
* `$VAR` in a value is expanded when the file is read, against
|
||||
Finit's environment. An unset variable expands to nothing.
|
||||
* `${VAR}` in a value is expanded when the file is read, against
|
||||
Finit's environment, and `${VAR:-default}` works too. An unset
|
||||
variable expands to nothing. A plain `$VAR` is left alone and
|
||||
reaches the service, which is what keeps `command = "syslogd -F
|
||||
$SYSLOGD_ARGS"` working with an `envfile`.
|
||||
* New settings only appear in the block format. The first are the
|
||||
[per-service directories](service-opts.md#service-directories),
|
||||
`runtime-dir` and friends.
|
||||
|
||||
Reference in new issue
Block a user