diff mbox series

[kmod,v2,13/17] man: add few mentions about MODPROBE_OPTIONS

Message ID 20240708-man-v2-13-a23df6ef871e@gmail.com (mailing list archive)
State Handled Elsewhere
Headers show
Series man: minor improvements, post the scdoc conversion | expand

Commit Message

Emil Velikov via B4 Relay July 8, 2024, 1:43 p.m. UTC 
From: Emil Velikov <emil.l.velikov@gmail.com>

The environment variable may alter config file ordering, so mention it
in the man page.

In addition, highlight that the format is intentionally undocumented
since the use by third parties is discouraged.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
v2: tweak (5) wording, add details to (8)
---
 man/modprobe.8.scd   | 8 ++++++--
 man/modprobe.d.5.scd | 3 +++
 2 files changed, 9 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd
index b47908b..321fa59 100644
--- a/man/modprobe.8.scd
+++ b/man/modprobe.8.scd
@@ -192,8 +192,12 @@  database.
 
 # ENVIRONMENT
 
-The MODPROBE_OPTIONS environment variable can also be used to pass arguments to
-*modprobe*.
+The MODPROBE_OPTIONS environment variable can also be used to pass command line
+arguments to *modprobe*. The format is intentionally left undocumented, since
+the use by third-party tools and scripts is discouraged.
+
+The environment variable originates with the implementation of the install
+rules.
 
 # COPYRIGHT
 
diff --git a/man/modprobe.d.5.scd b/man/modprobe.d.5.scd
index 823ba62..b7b1942 100644
--- a/man/modprobe.d.5.scd
+++ b/man/modprobe.d.5.scd
@@ -49,6 +49,9 @@  directory they reside in. Configuration files can either be completely replaced
 priority) or partially replaced (by having a configuration file that is ordered
 later).
 
+NOTE: The configuration directories may be altered via the MODPROBE_OPTIONS
+environment variable. See the ENVIRONMENT section in *modprobe*(8).
+
 # COMMANDS
 
 alias _wildcard_ _modulename_