From a4e5ef7485cfcca6f420fa2b00116e0394eb0ae9 Mon Sep 17 00:00:00 2001 From: Jai Luthra Date: Mon, 23 Jan 2023 13:01:17 +0530 Subject: [PATCH] README: update template --- README.md | 4 +++- tools/readme-autogen/templates/linux_readme_master.tmpl | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7a9aaae..3a3dea6 100644 --- a/README.md +++ b/README.md @@ -222,7 +222,7 @@ Examples are provided for driver version 430.50. All commands are executed as ro ### Download and install driver -Skip this step if you already have installed driver with version supported by this patch (from distro packages, for example). +Skip this step if you already have installed driver with version supported by this patch. Make sure you have kernel headers and compiler installed before running Nvidia driver installer. Kernel headers and compiler are required to build nvidia kernel module. Recommended way to do this is to install `dkms` package, if it is available in your distro. This way `dkms` package will pull all required dependencies to allow building kernel modules and kernel module builds will be automated in a reliable fashion. @@ -252,6 +252,8 @@ bash ./patch.sh You're all set! +**Note:** Sometimes distribution installed drivers are not found by the patch script. In that case, please uninstall the nvidia driver using your distribution package manager, and install it using the steps [above](#download-and-install-driver). + ## Rollback If something got broken you may restore patched driver from backup: diff --git a/tools/readme-autogen/templates/linux_readme_master.tmpl b/tools/readme-autogen/templates/linux_readme_master.tmpl index be89af7..328bba8 100644 --- a/tools/readme-autogen/templates/linux_readme_master.tmpl +++ b/tools/readme-autogen/templates/linux_readme_master.tmpl @@ -79,7 +79,7 @@ Examples are provided for driver version ${example_driver_version}. All commands ### Download and install driver -Skip this step if you already have installed driver with version supported by this patch (from distro packages, for example). +Skip this step if you already have installed driver with version supported by this patch. Make sure you have kernel headers and compiler installed before running Nvidia driver installer. Kernel headers and compiler are required to build nvidia kernel module. Recommended way to do this is to install `dkms` package, if it is available in your distro. This way `dkms` package will pull all required dependencies to allow building kernel modules and kernel module builds will be automated in a reliable fashion. @@ -109,6 +109,8 @@ bash ./patch.sh You're all set! +**Note:** Sometimes distribution installed drivers are not found by the patch script. In that case, please uninstall the nvidia driver using your distribution package manager, and install it using the steps [above](#download-and-install-driver). + ## Rollback If something got broken you may restore patched driver from backup: