[bug#55231,2/2] doc: ‘initrd-modules’ will search ‘kernel-loadable-modules’.

Message ID 20250205220421.23774-2-morgan.arnold@proton.me
State New
Headers
Series [bug#55231,1/2] Allows copying of out-of-tree modules to the Linux initrd. |

Commit Message

Morgan Arnold Feb. 5, 2025, 10:04 p.m. UTC
  From: Brian Cully <bjc@spork.org>

---
 doc/guix.texi | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
  

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index bb5f29277f..2ca8bbda51 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -43252,6 +43252,21 @@  file system, you would write:
   (initrd-modules (cons "megaraid_sas" %base-initrd-modules)))
 @end lisp
 
+If a module listed in @code{initrd-modules} is not included in the
+Linux-libre kernel, then the location to it must be added to the
+@code{kernel-loadable-modules} list.
+
+For example, if you need the driver for a Realtek RTL8821CE wireless
+network adapter for mounting the root filesystem over NFS, your
+configuration might include the following:
+
+@lisp
+(operating-system
+  ;; @dots{}
+  (initrd-modules (cons "8821ce" %base-initrd-modules))
+  (kernel-loadable-modules (list (list rtl8821ce-linux-module "module"))))
+@end lisp
+
 @defvar %base-initrd-modules
 This is the list of kernel modules included in the initrd by default.
 @end defvar