From 6c2edca52b72150552f74759ab014238533650f1 Mon Sep 17 00:00:00 2001 From: DougTW Date: Wed, 17 Jul 2019 11:27:41 -0700 Subject: [PATCH] Fixed broken link in kernel-modules-dkms.rst. (#632) - Resolved merge conflicts. Signed-off-by: DougTW Clean-up and testing to resolve conflicts. Signed-off-by: Michael Vincerra --- .../maintenance/kernel-modules-dkms.rst | 66 ++++++++----------- 1 file changed, 29 insertions(+), 37 deletions(-) diff --git a/source/clear-linux/guides/maintenance/kernel-modules-dkms.rst b/source/clear-linux/guides/maintenance/kernel-modules-dkms.rst index 524a5c66..d03ff743 100644 --- a/source/clear-linux/guides/maintenance/kernel-modules-dkms.rst +++ b/source/clear-linux/guides/maintenance/kernel-modules-dkms.rst @@ -6,7 +6,8 @@ Add kernel modules with DKMS Certain kernel modules are enabled by default in |CL-ATTR|. To use additional kernel modules that are not part of the Linux source tree, you may need to build out-of-tree kernel modules. Use this guide to add kernel modules with -:abbr:`DKMS (Dynamic Kernel Module System)` or refer to :ref:`kernel-modules`. +:abbr:`DKMS (Dynamic Kernel Module System)` or refer to +:ref:`kernel-modules`. .. contents:: :local: :depth: 1 @@ -24,15 +25,10 @@ come from an external source, such as directly from a vendor (out-of-tree). the building and installation of kernel modules. DKMS allows |CL| to provide hooks that automatically rebuild modules against new kernel versions. - - .. include:: kernel-modules.rst :start-after: kernel-modules-availability-begin: :end-before: kernel-modules-availability-end: - - - Install DKMS ************ @@ -57,11 +53,10 @@ The *kernel-native-dkms* bundle also: .. warning:: - We recommend that you always review the :command:`swupd update` output - to make sure kernel modules were successfully rebuilt against the new - kernel. This is especially important for systems where a successful boot - relies on a kernel module. - + We recommend that you always review the :command:`swupd update` output + to make sure kernel modules were successfully rebuilt against the new + kernel. This is especially important for systems where a successful boot + relies on a kernel module. Install the :command:`kernel-native-dkms` or :command:`kernel-lts-dkms` bundle: @@ -99,17 +94,19 @@ bundle: sudo clr-boot-manager update reboot - .. _kernel-modules-dkms-install-end: Build, install, and load an out-of-tree module ********************************************** -Follow the steps in this section if you are an individual user or testing, and -you need an out-of-tree kernel module that is not available through |CL|. For -a more scalable and customizable approach, we recommend using the -:ref:`mixer` tool to provide a custom kernel and updates. - +Follow the steps in this section if you are an individual user or testing, +and you need an out-of-tree kernel module that is not available through +<<<<<<< HEAD +|CL|. For a more scalable and customizable approach, we recommend using +======= +|CL|. For a more scalable and customizable approach, we recommend using the +>>>>>>> 43c2991... Clean-up and testing to resolve conflicts. +:ref:`mixer` to provide a custom kernel and updates. Prerequisites ============= @@ -119,10 +116,14 @@ Before you begin, you must: * Disable Secure Boot in UEFI/BIOS. The loading of new out-of-tree modules modifies the signatures that Secure Boot relies on for trust. -* Obtain a kernel module package in the form of source code and/or precompiled +<<<<<<< HEAD +* Obtain a kernel module package in the form of source code or + pre-compiled binaries. + +======= +* Obtain a kernel module package in the form of source code or pre-compiled binaries. - - +>>>>>>> 43c2991... Clean-up and testing to resolve conflicts. Obtain kernel module source =========================== @@ -159,7 +160,6 @@ a :file:`dkms.conf` file, described later in this document. cd / cat README - Build kernel module with an existing dkms.conf ============================================== @@ -171,8 +171,8 @@ The archive contains the required :file:`dkms.conf` file, and may contain a :file:`dkms_source_tree` directory and a :file:`dkms_binaries_only` directory. - -#. Run the :command:`dkms ldtarball` command against the kernel module archive. +#. Run the :command:`dkms ldtarball` command against the kernel + module archive. .. code-block:: bash @@ -180,8 +180,8 @@ directory. :command:`dkms ldtarball` places the kernel module source under - :file:`/usr/src/-/`, builds it if necessary, and - adds the module into the DKMS tree. + :file:`/usr/src/-/`, builds it if necessary, + and adds the module into the DKMS tree. #. Verify the kernel module is detected by checking the output of the @@ -198,8 +198,6 @@ directory. dkms install -m -v - - Build kernel module without an existing dkms.conf ================================================= @@ -224,7 +222,7 @@ Here are some additional resources that can be used for reference: .. note:: :command:`AUTOINSTALL=yes` must be set in the dkms.conf for the module to - be automatically recompiled with |CL| updates. + be automatically recompiled with |CL| updates. The instructions below show a generic example: @@ -259,14 +257,14 @@ The instructions below show a generic example: ** and ** must match the entries in the :file:`dkms.conf` file. - #. Add the kernel module to the DKMS tree so that it is tracked by DKMS. .. code-block:: bash sudo dkms add -m -#. Build the kernel module using DKMS. If the build encounters errors, you may +#. Build the kernel module using DKMS. If the build encounters errors, + you may need to edit the :file:`dkms.conf` file. .. code-block:: bash @@ -279,15 +277,13 @@ The instructions below show a generic example: sudo dkms install -m -v - - Load kernel module ================== By default, DKMS installs modules "in-tree" under :file:`/lib/modules` so the :command:`modprobe` command can be used to load them. -#. Load the installed module with the :command:`modprobe` command. +#. Load the installed module with the :command:`modprobe` command. .. code-block:: bash @@ -299,7 +295,6 @@ By default, DKMS installs modules "in-tree" under :file:`/lib/modules` so the lsmod | grep - Examples ******** @@ -307,9 +302,6 @@ Examples :start-after: kernel-modules-autoload-begin: :end-before: kernel-modules-autoload-end: - - - Related topics **************