docs: admin-guide: update description for kernel.modprobe sysctl
diff mbox series

Message ID 20210420125324.1246826-1-linux@rasmusvillemoes.dk
State In Next
Commit 584eb53d2c716746da9cfa9d20c80726f92ffb1f
Headers show
Series
  • docs: admin-guide: update description for kernel.modprobe sysctl
Related show

Commit Message

Rasmus Villemoes April 20, 2021, 12:53 p.m. UTC
When I added CONFIG_MODPROBE_PATH, I neglected to update
Documentation/. It's still true that this defaults to /sbin/modprobe,
but now via a level of indirection. So document that the kernel might
have been built with something other than /sbin/modprobe as the
initial value.

Signed-off-by: Rasmus Villemoes <linux@rasmusvillemoes.dk>
---

Andrew, this is a followup or a fixup, however you want to handle it,
to "modules: add CONFIG_MODPROBE_PATH" (in next-20210419 known as
8bc50a36278dbf3e14b25236e3acee25f75d5bd8). I.e., please add this as-is
to your patch queue, or fold this into that one.

 Documentation/admin-guide/sysctl/kernel.rst | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

Comments

Rasmus Villemoes May 10, 2021, 10:20 a.m. UTC | #1
On 20/04/2021 14.53, Rasmus Villemoes wrote:
> When I added CONFIG_MODPROBE_PATH, I neglected to update
> Documentation/. It's still true that this defaults to /sbin/modprobe,
> but now via a level of indirection. So document that the kernel might
> have been built with something other than /sbin/modprobe as the
> initial value.
> 

Andrew, can I get you to pick this up? It's a follow-up to what is now
known as 17652f4240f7.

Rasmus

Patch
diff mbox series

diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
index 1d56a6b73a4e..7ca8df5451d4 100644
--- a/Documentation/admin-guide/sysctl/kernel.rst
+++ b/Documentation/admin-guide/sysctl/kernel.rst
@@ -483,10 +483,11 @@  modprobe
 ========
 
 The full path to the usermode helper for autoloading kernel modules,
-by default "/sbin/modprobe".  This binary is executed when the kernel
-requests a module.  For example, if userspace passes an unknown
-filesystem type to mount(), then the kernel will automatically request
-the corresponding filesystem module by executing this usermode helper.
+by default ``CONFIG_MODPROBE_PATH``, which in turn defaults to
+"/sbin/modprobe".  This binary is executed when the kernel requests a
+module.  For example, if userspace passes an unknown filesystem type
+to mount(), then the kernel will automatically request the
+corresponding filesystem module by executing this usermode helper.
 This usermode helper should insert the needed module into the kernel.
 
 This sysctl only affects module autoloading.  It has no effect on the