diff --git a/source/FAQ/index.rst b/source/FAQ/index.rst index 2cd81751..5766da4e 100644 --- a/source/FAQ/index.rst +++ b/source/FAQ/index.rst @@ -9,7 +9,6 @@ Below is a list of commonly asked questions with answers sourced from the .. contents:: :local: :depth: 2 - General ******* diff --git a/source/get-started/bare-metal-install-desktop.rst b/source/get-started/bare-metal-install-desktop.rst index 490d55e7..c5e75896 100644 --- a/source/get-started/bare-metal-install-desktop.rst +++ b/source/get-started/bare-metal-install-desktop.rst @@ -352,9 +352,9 @@ Optional: Skip to `Finish installation`_. Telemetry ========= -Choose whether to participate in `telemetry`. Telemetry is a |CL| +Choose whether to participate in `telemetry`. :ref:`telem-guide` is a |CL| feature that reports failures and crashes to the |CL| development -team for improvements. For more information, see :ref:`telem-guide`. +team for improvements. #. From :guilabel:`Required Options`, select :guilabel:`Telemetry`. diff --git a/source/get-started/bare-metal-install-server.rst b/source/get-started/bare-metal-install-server.rst index f884ee69..1638c3db 100644 --- a/source/get-started/bare-metal-install-server.rst +++ b/source/get-started/bare-metal-install-server.rst @@ -392,11 +392,10 @@ be configured post-installation using the ``cryptsetup`` tool. Telemetry ========= -Telemetrics is a |CL| feature that reports failures and crashes to -the |CL| development team for improvements. For more detailed information, -visit our :ref:`telem-guide` guide. +:ref:`telem-guide` is a |CL| feature that reports failures and crashes to +the |CL| development team for improvements. -Select your desired option on whether to participate in `telemetry`. +Select your desired option on whether to participate in telemetry. #. In the Main Menu, navigate to :guilabel:`Telemetry` and select :kbd:`Enter`. diff --git a/source/guides/clear/autospec.rst b/source/guides/clear/autospec.rst index 08446edf..7dabfd58 100644 --- a/source/guides/clear/autospec.rst +++ b/source/guides/clear/autospec.rst @@ -3,10 +3,11 @@ autospec ######## -**autospec** is a tool used to assist with the automated creation and maintenance of -RPM packaging in |CL-ATTR|. Where a standard :abbr:`RPM (RPM Package Manager)` build process using -:command:`rpmbuild` requires a tarball and :file:`.spec` file to start, autospec -requires only a tarball and package name to start. +**autospec** is a tool used to assist with the automated creation and +maintenance of RPM packaging in |CL-ATTR|. Where a standard +:abbr:`RPM (RPM Package Manager)` build process using :command:`rpmbuild` +requires a tarball and :file:`.spec` file to start, autospec requires only a +tarball and package name to start. .. contents:: :local: diff --git a/source/guides/clear/bundles.rst b/source/guides/clear/bundles.rst index e27c6ebc..52cc194d 100644 --- a/source/guides/clear/bundles.rst +++ b/source/guides/clear/bundles.rst @@ -18,4 +18,10 @@ The |CL-ATTR| takes a slightly different approach. While we also use the concept of packages to manage compiling source code into binaries, we do not use the package concept to deploy software. Instead, we provide software "bundles" that are installed and managed using :ref:`swupd`. -Each bundle contains as many or as few open source projects needed to provide a complete functionality. \ No newline at end of file +Each bundle contains as many or as few open source projects needed to provide a +complete functionality. + +Related topics +************** + +* :ref:`swupd-guide` \ No newline at end of file diff --git a/source/tutorials/nvidia.rst b/source/tutorials/nvidia.rst index d46be89e..3ca52694 100644 --- a/source/tutorials/nvidia.rst +++ b/source/tutorials/nvidia.rst @@ -4,19 +4,19 @@ NVIDIA\* Drivers ################ NVIDIA manufactures graphics processing units (GPU), also known as -graphics cards. +graphics cards. NVIDIA devices on Linux\* have two popular device driver options: the opensource drivers from the `nouveau project`_ or the proprietary drivers published by NVIDIA. The nouveau drivers are built into the |CL-ATTR| kernel and are loaded automatically at system boot if a compatible card -is detected. +is detected. These instructions show how to use the proprietary NVIDIA drivers, which require a manual installation. .. warning:: - + Software installed outside of :ref:`swupd ` is not updated with |CL| updates and must be updated and maintained manually. @@ -25,26 +25,21 @@ require a manual installation. update overwrites these files, a reinstallation of the NVIDIA driver might be required. - - .. contents:: :local: - :depth: 2 + :depth: 1 - - -Prerequisites +Prerequisites ************* * A |CL| system with a desktop installed * An NVIDIA device installed - Install DKMS ************ The :ref:`Dynamic Kernel Module System (DKMS) ` allows the NVIDIA kernel modules to be automatically -integrated when kernel updates occur in |CL|. +integrated when kernel updates occur in |CL|. Install the appropriate DKMS bundle using the instructions below: @@ -52,16 +47,13 @@ Install the appropriate DKMS bundle using the instructions below: The Long Term Support (LTS) kernel variant is more likely to remain compatible between updates with NVIDIA drivers. - .. include:: /guides/kernel/kernel-modules-dkms.rst :start-after: kernel-modules-dkms-install-begin: :end-before: kernel-modules-dkms-install-end: - Download and install the NVIDIA drivers *************************************** - Download the NVIDIA drivers for Linux ===================================== @@ -71,11 +63,9 @@ Download the NVIDIA drivers for Linux sudo lshw -C display - #. Go to the `NVIDIA Driver Downloads website`_ . Search for and download the appropriate driver based on the NVIDIA GPU model you have with *Linux - 64-bit* selected as the Operating System . - + 64-bit* selected as the Operating System . #. Open a terminal and navigate to where the :file:`NVIDIA-Linux-x86_64-.run` file was saved. In this @@ -91,7 +81,6 @@ Download the NVIDIA drivers for Linux chmod +x :file:`NVIDIA-Linux-x86_64-.run` - Disable the nouveau driver ========================== @@ -106,14 +95,10 @@ must be disabled before installation can continue. sudo mkdir /etc/modprobe.d printf "blacklist nouveau \noptions nouveau modeset=0 \n" | sudo tee --append /etc/modprobe.d/disable-nouveau.conf - #. Reboot the system and log back in. It is normal for the graphical environment not to start without the NVIDIA driver loaded. - - - Configure alternative software paths ==================================== @@ -123,19 +108,18 @@ rest of the |CL| system files under :file:`/usr`. The dynamic linker and X server must be configured to use the content under :file:`/opt/nvidia`. - #. Configure the dynamic linker to look for and to cache shared libraries under :file:`/opt/nvidia/lib` and :file:`/opt/nvidia/lib32` in addition to the default paths. .. code-block:: bash - + echo "include /etc/ld.so.conf.d/*.conf" | sudo tee --append /etc/ld.so.conf - + sudo mkdir /etc/ld.so.conf.d printf "/opt/nvidia/lib \n/opt/nvidia/lib32 \n" | sudo tee --append /etc/ld.so.conf.d/nvidia.conf -#. Reload the dynamic linker run-time bindings and library cache. +#. Reload the dynamic linker run-time bindings and library cache. .. code-block:: bash @@ -147,7 +131,7 @@ server must be configured to use the content under .. code-block:: bash sudo mkdir -p /etc/X11/xorg.conf.d/ - + sudo tee /etc/X11/xorg.conf.d/nvidia-files-opt.conf > /dev/null <<'EOF' Section "Files" ModulePath "/usr/lib64/xorg/modules" @@ -155,27 +139,23 @@ server must be configured to use the content under EndSection EOF - Install the NVIDIA drivers ========================== - #. A terminal not running on */dev/tty1* is useful to view uninterrupted installation progress. Switch to a secondary virtual terminal by pushing - :command:`CTRL + ALT + F2` or remotely login over SSH. - + :command:`CTRL + ALT + F2` or remotely login over SSH. #. Navigate to the directory where the NVIDIA installer was downloaded. .. code-block:: bash - cd ~/Downloads/ - + cd ~/Downloads/ #. Run the installer with the advanced options below. .. code-block:: bash - + sudo ./NVIDIA-Linux-x86_64-.run \ --utility-prefix=/opt/nvidia \ --opengl-prefix=/opt/nvidia \ @@ -199,13 +179,11 @@ Install the NVIDIA drivers #. The graphical interface may automatically start after the NVIDIA driver is loaded. Return to the working terminal and log back in if necessary. - #. Confirm that the NVIDIA kernel modules are loaded. .. code-block:: bash - lsmod | grep ^nvidia - + lsmod | grep ^nvidia #. Run a |CL| system verification to restore files that the NVIDIA installer likely deleted. @@ -223,16 +201,15 @@ Install the NVIDIA drivers other uses of the :command:`swupd repair` command should be avoided with the proprietary NVIDIA drivers installed. - Updating the NVIDIA drivers *************************** -The proprietary NVIDIA drivers are installed manually outside of :ref:`swupd -` and must be updated manually when needed. +The proprietary NVIDIA drivers are installed manually outside of +:ref:`swupd ` and must be updated manually when needed. Updating the NVIDIA drivers follows the same steps as initial installation, however the desktop environment must first be stopped so that the drivers are -not in use. +not in use. #. Follow the steps in the `Download the NVIDIA Drivers for Linux`_ section to get the latest NVIDIA drivers. @@ -244,7 +221,6 @@ not in use. sudo systemctl set-default multi-user.target - #. Reboot the system and log back in. It is normal for the graphical environment not to start. @@ -258,8 +234,7 @@ not in use. sudo systemctl set-default graphical.target - -#. Reboot the system and log back in. +#. Reboot the system and log back in. #. Trigger a flatpak update that will download the runtime corresponding with the new NVIDIA drivers for the flatpak apps that require it. @@ -268,12 +243,11 @@ not in use. flatpak update - Uninstalling the NVIDIA drivers ******************************* The NVIDIA drivers and associated software can be uninstalled and nouveau -driver restored with the instructions in this section. +driver restored with the instructions in this section. #. Remove the :file:`modprobe.d` file that prevents nouveau from loading. @@ -281,7 +255,6 @@ driver restored with the instructions in this section. sudo rm /etc/modprobe.d/disable-nouveau.conf - #. Remove the :file:`xorg.conf.d` file that adds a search path for X modules. .. code:: bash @@ -290,23 +263,20 @@ driver restored with the instructions in this section. #. Run the :command:`sudo /opt/nvidia/bin/nvidia-uninstall` -#. Follow the prompts on the screen and reboot the system. +#. Follow the prompts on the screen and reboot the system. - -Debugging installation of NVIDIA drivers +Debugging installation of NVIDIA drivers **************************************** * The NVIDIA driver places installer and uninstaller logs under :file:`/var/log/nvidia-install` and :file:`/var/log/nvidia-uninstall`. * :file:`NVIDIA-Linux-x86_64-.run --advanced-options` shows many - parameters to control installation behavior. + parameters to control installation behavior. * :file:`NVIDIA-Linux-x86_64-.run --extract-only` extracts installation files into a directory named - :file:`NVIDIA-Linux-x86_64-`. - - + :file:`NVIDIA-Linux-x86_64-`. Additional resources ******************** @@ -320,5 +290,3 @@ Additional resources .. _`nouveau project`: https://nouveau.freedesktop.org/wiki/ .. _`NVIDIA Driver Downloads website`: https://www.nvidia.com/download/index.aspx - -