public inbox for gentoo-dev@lists.gentoo.org
 help / color / mirror / Atom feed
* [gentoo-dev] Common options missed in OpenRC declarative scripts and how to improve them
@ 2021-12-02  2:02 Brian Evans
  2021-12-02 12:34 ` Michael Orlitzky
  0 siblings, 1 reply; 6+ messages in thread
From: Brian Evans @ 2021-12-02  2:02 UTC (permalink / raw
  To: gentoo-dev


[-- Attachment #1.1: Type: text/plain, Size: 2307 bytes --]

After a cursory scan of the Gentoo repository, I've noticed an
overabundance of start_stop_daemon_args being declared in scripts committed.

I would like to draw attention and see if we can clean these up together.

The reason why these are important is the modular nature of the
declarative syntax. For example, supervise-daemon should be available to
any user for a declarative script by simply adding
supervisor="supervise-daemon" to the corresponding conf.d file.

There are many necessary options like --wait or --env which don't have a
declarative replacement.

These comments are for scripts without a start/stop function defined
thereby relying on the default scripts in /lib/rc/sh/.  There are other
advanced cases for sure.  I just want to discuss easy to forget options.

Common mistakes included with start_stop_daemon_args:

"--background --make-pidfile" ("-b -m")  should be replaced by
command_background="yes" (these are implied together)

"--user" and/or "--group" should be command_user="user:group" (use root
for user when only group is needed, the :group can be omitted)

"--chdir /path/to/foo" (-d) should be directory="/path/to/foo"

"--chroot /var/chroot/foo" (-r) should be chroot="/var/chroot/foo"

"--stdout /var/log/foo" (-1) should be output_log="/var/log/foo"

"--stderr /var/log/foo.err" (-2) should be error_log="/var/log/foo.err"

"--pidifle /run/foo.pid" (-p) should be pidfile="/run/foo.pid"

"--name foo" (-n) should be procname="foo"

"--exec" (-x) should be deleted as it is included by default when
command="" is declared (required to exist)

In addition, command_args may need to be reevaluated for each script to
split certain pieces out into command_args_foreground and
command_args_background.

command_args_foreground should include any options to force the
daemon/script into the foreground instead of forking.

command_args_background should include any option to fork a daemon and,
optionally, to have it write a pidfile to monitor. (Cannot be used
together with command_background option).

command_args should not include the conditions of the other two in most
cases.

If anyone would want me to do work in obvious cleanups, I am open to
bugs, patches or just committing.

Comments welcome.

Brian

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 840 bytes --]

^ permalink raw reply	[flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-12-03  9:40 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-12-02  2:02 [gentoo-dev] Common options missed in OpenRC declarative scripts and how to improve them Brian Evans
2021-12-02 12:34 ` Michael Orlitzky
2021-12-02 16:12   ` Alec Warner
2021-12-02 18:05     ` Michael Orlitzky
2021-12-03  9:39       ` Marc Schiffbauer
2021-12-02 16:17   ` Brian Evans

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox