From 9fc212638652fb9bfd810ec3d22a2a5d26f4292c Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 23 Jan 2025 14:47:03 +0100 Subject: [PATCH] units: add a longer comment to modprobe@.service explaining when to use it --- units/modprobe@.service | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/units/modprobe@.service b/units/modprobe@.service index 05e5b4f6001..b099b90ebab 100644 --- a/units/modprobe@.service +++ b/units/modprobe@.service @@ -7,6 +7,20 @@ # the Free Software Foundation; either version 2.1 of the License, or # (at your option) any later version. +# This unit loads a specific kernel module explicitly and synchronizes on its +# initialization to be complete. This unit should only be used as dependency +# if automatic module loading cannot be used for a module, i.e. in exceptional +# cases. These cases may include: +# +# 1. The primary API exposed by the module is a device node that is normally +# managed by systemd-tmpfiles-setup-dev-early.service (and thus auto-loading +# is generally supported), but some service already needs the functionality +# during even earlier boot. +# +# 2. The primary API exposed by the module is some directory in /sys/, /proc/ +# or configfs, where simple access generally is not sufficient to load the +# module. + [Unit] Description=Load Kernel Module %i DefaultDependencies=no