Skip to content

Commit 8acb734

Browse files
committed
man: add MODULE_ALTERNATIVE_DIRECTORY documentation
Esplicitly define MODULE_ALTERNATIVE_DIRECTORY in the docs as fallback directory if MODULE_DIRECTORY is missing or the module is not present there. Signed-off-by: Emanuele Giuseppe Esposito <[email protected]>
1 parent 2c9821c commit 8acb734

File tree

5 files changed

+33
-3
lines changed

5 files changed

+33
-3
lines changed

man/insmod.8.scd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ Only the most general of error messages are reported: as the work of trying to
1818
link the module is now done inside the kernel, the *dmesg*(1) usually gives more
1919
information about errors.
2020

21+
*insmod* will look by default at modules stored in @MODULE_DIRECTORY@, but if
22+
the folder is missing or the module is not found, it will automatically look at
23+
the fallback directory @MODULE_ALTERNATIVE_DIRECTORY@.
24+
This program will fail only if the provided module is not found in both
25+
directories.
26+
2127
# OPTIONS
2228

2329
*-f*, *--force*

man/lsmod.8.scd

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ lsmod - Show the status of modules in the Linux Kernel
1313
*lsmod* is a trivial program which nicely formats the contents of the
1414
_/proc/modules_, showing what kernel modules are currently loaded.
1515

16+
*lsmod* will look by default at modules stored in @MODULE_DIRECTORY@, but if
17+
the folder is missing , it will automatically look at the fallback directory @MODULE_ALTERNATIVE_DIRECTORY@.
18+
1619
# OPTIONS
1720

1821
*-s*, *--syslog*

man/modinfo.8.scd

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,18 @@ modinfo - Show information about a Linux Kernel module
1515
# DESCRIPTION
1616

1717
*modinfo* extracts information from the Linux Kernel modules given on the
18-
command line. If the module name is not a filename, then the @MODULE_DIRECTORY@/
19-
_version_ directory is searched, as is also done by *modprobe*(8) when loading
20-
kernel modules.
18+
command line.
19+
20+
*modinfo* will search by default for modules stored in @MODULE_DIRECTORY@, but
21+
if the folder is missing or the module is not found, it will automatically look
22+
at the fallback directory @MODULE_ALTERNATIVE_DIRECTORY@.
23+
This program will fail only if the provided module is not found in both
24+
directories.
25+
26+
If the module name is not a filename, then the @MODULE_DIRECTORY@/
27+
_version_ directory is searched first, and then
28+
@MODULE_ALTERNATIVE_DIRECTORY@/_version_, as is also done by *modprobe*(8) when
29+
loading kernel modules.
2130

2231
*modinfo* by default lists each attribute of the module in form _fieldname_ :
2332
_value_, for easy reading. The filename is listed the same way (although it's

man/modprobe.8.scd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@ is relative, it must explicitly start with "./". Note that this may fail when
4444
using a path to a module with dependencies not matching the installed *depmod*
4545
database.
4646

47+
*modprobe* will search by default for modules stored in @MODULE_DIRECTORY@, but
48+
if the folder is missing or the module is not found, it will automatically look
49+
at the fallback directory @MODULE_ALTERNATIVE_DIRECTORY@.
50+
This program will fail only if the provided module is not found in both
51+
directories.
52+
4753
# OPTIONS
4854

4955
*-a*, *--all*

man/rmmod.8.scd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ kernel (when module unloading support is provided). Most users will want to use
1515
*modprobe*(8) with the *-r* option instead since it removes unused dependent
1616
modules as well.
1717

18+
*rmmod* will look by default at modules stored in @MODULE_DIRECTORY@, but if
19+
the folder is missing or the module is not found, it will automatically look at
20+
the fallback directory @MODULE_ALTERNATIVE_DIRECTORY@.
21+
This program will fail only if the provided module is not found in both
22+
directories.
23+
1824
When a list of modules is provided, the program will process them one at a time.
1925
If a module is not found, *rmmod* will immediately exit with an error code.
2026
Should the module removal fail, the program will log an error AND continue with

0 commit comments

Comments
 (0)