From 60d975b3fa54f0e9e8d5ce5ee6999f8dc5dad8af Mon Sep 17 00:00:00 2001 From: michael vincerra <37549381+mvincerx@users.noreply.github.com> Date: Fri, 10 Jul 2020 10:32:49 -0700 Subject: [PATCH] Add include in ZFS tutorial to reference kernel-module-dkms (#1200) * Adds targets for include in source doc. Signed-off-by: Michael Vincerra * Adds include directive pointing to new targets in kernel-modules-dkms - Keep documentation DRY and modular. Signed-off-by: Michael Vincerra --- source/guides/kernel/kernel-modules-dkms.rst | 7 ++++-- source/tutorials/zfs.rst | 26 +++----------------- 2 files changed, 8 insertions(+), 25 deletions(-) diff --git a/source/guides/kernel/kernel-modules-dkms.rst b/source/guides/kernel/kernel-modules-dkms.rst index 20b686ee..3d7ea95d 100644 --- a/source/guides/kernel/kernel-modules-dkms.rst +++ b/source/guides/kernel/kernel-modules-dkms.rst @@ -64,8 +64,10 @@ The :command:`kernel-native-dkms` bundle also: kernel. This is especially important for systems where a successful boot relies on a kernel module. +.. _kernel-modules-dkms-install-begin-alt: + Install the :command:`kernel-native-dkms` or :command:`kernel-lts-dkms` -bundle: +bundle. #. Determine which kernel variant is running on |CL|. Only the *native* and *lts* kernels are enabled to build and load out-of-tree kernel modules @@ -93,7 +95,8 @@ bundle: sudo swupd bundle-add kernel-lts-dkms -#. Update the |CL| bootloader and reboot. +#. Update the |CL| bootloader and reboot, and + ensure that you can start the new kernel. .. code-block:: bash diff --git a/source/tutorials/zfs.rst b/source/tutorials/zfs.rst index 354be519..369a4c1f 100644 --- a/source/tutorials/zfs.rst +++ b/source/tutorials/zfs.rst @@ -32,29 +32,9 @@ Prerequisites Install the DKMS kernel ======================= -If you do not currently use a DKMS kernel, install it by using one of the options below. - -#. Check whether you have an LTS or native kernel: - - .. code-block:: bash - - uname -r - - a. If 'native' appears in the kernel name, then install a native - kernel with DKMS support: - - .. code-block:: bash - - sudo swupd bundle-add kernel-native-dkms - - #. If 'lts' appears in the kernel name, then install the latest LTS - kernel with DKMS support: - - .. code-block:: bash - - sudo swupd bundle-add kernel-lts-dkms - -#. Reboot and make sure you can start the new kernel. +.. include:: ../guides/kernel/kernel-modules-dkms.rst + :start-after: kernel-modules-dkms-install-begin-alt: + :end-before: kernel-modules-dkms-install-end: Bundles =======