Commit 7bb4d028 authored by Tim Writer's avatar Tim Writer
Browse files

Merge branch 'releases/amd-5.4' into 'master'

Update doc to 22.40 release

See merge request !6
parents e716a335 1d57deec
Loading
Loading
Loading
Loading
+1 −1
Changes for source/conf.py: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -47,7 +47,7 @@ master_doc = 'index'

# General information about the project.
project = u'amdgpu graphics and compute stack'
copyright = u'Advanced Micro Devices 2017, ' + str(datetime.date.today().year)
copyright = u'Advanced Micro Devices 2022, ' + str(datetime.date.today().year)
author = u'Advanced Micro Devices, Inc.'

# The version info for the project you're documenting, acts as replacement for
+7 −1
Changes for source/install-installing.rst: 7 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -4,6 +4,9 @@ Installing or Uninstalling the AMDGPU stack

.. contents:: Table of Contents

.. note:: If you are installing on a low memory system, it is advised to
      increase swap size during installation to avoid out of memory issues.

----------

Installing the All-Open Use Case
@@ -217,6 +220,8 @@ the key certificate. Select "Reboot" to exit the MOK manager.

The signed driver should now load successfully.

.. _Uninstalling-the-AMDGPU-stack:

Uninstalling the AMDGPU stack
=============================

@@ -228,7 +233,8 @@ in the system.
   .. code-block:: bash

    $ amdgpu-uninstall

    # or the following is also equivalent:
    $ amdgpu-install --uninstall

2. After uninstalling the components, reboot the target system.

+4 −3
Changes for source/install-overview.rst: 4 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -64,9 +64,10 @@ or ``--usecase``, such as:
See ``amdgpu-install -h`` for more options or ``amdgpu-install --list-usecase``
for more available usecases.

.. note:: In the 21.40 release, ``amdgpu-install`` has changed and some options
    available in previous releases have been removed. ``amdgpu-pro-install``
    has been dropped, but the following equivalent command can be used instead:
.. note:: Starting with the 21.40 release, ``amdgpu-install`` has changed and
    some options available in previous releases have been removed.
    ``amdgpu-pro-install`` has been dropped, but the following equivalent
    command can be used instead:
    ``amdgpu-install --usecase=workstation --vulkan=pro``.

.. note::
+50 −24
Changes for source/install-prereq.rst: 50 added lines, 24 removed lines.
Original line number Diff line number Diff line
@@ -6,6 +6,18 @@ Prerequisites

----------

Removing existing installation
******************************

If the AMDGPU stack has been previously installed on the target system, it is
highly recommended to uninstall prior to installing the upgraded stack.
While upgrading the stack with the package manager will often work without
issue, installing the stack on a clean system is recommended for best results.

See :ref:`Uninstalling-the-AMDGPU-stack` for uninstall instructions.

---------

Downloading the Installer Package
**********************************

@@ -19,30 +31,6 @@ Download the installer package to the system (for example, to ``~/Downloads``),
and install it using the package manager, which will make the installation
script available on your system.

--------

Installing the Installer Package
*********************************

In the following commands, replace ``amdgpu-install-VERSION.{deb,rpm}`` with
the actual file name of the downloaded installer package:

.. code-block:: bash

 $ cd ~/Downloads
 # For Ubuntu:
 $ sudo apt-get install ./amdgpu-install-VERSION.deb
 $ sudo apt-get update
 # For RHEL:
 $ sudo yum install ./amdgpu-install-VERSION.rpm
 # For SLE:
 $ sudo zypper install ./amdgpu-install-VERSION.rpm

.. note:: Installing "amdgpu-install" will add the installer and AMD related
   repositories to your system. The repositories will be accessible to the
   system package manager, which is in turn used by the installer.


---------

Configuring Access to the Distribution Repository (RHEL and SLE only)
@@ -65,3 +53,41 @@ dependency resolution. You must ensure **one** of the following:
.. note:: It is assumed most customers have a subscription with access to
      online repositories or are using a Linux distribution which does not
      require a subscription and has online repositories enabled by default.

--------

Update the Operating System
****************************

Before installing the AMDGPU stack, it's recommended to update your system:

.. code-block:: bash

 # For Ubuntu:
 $ sudo apt-get update
 $ sudo apt-get dist-upgrade
 # For RHEL:
 $ sudo yum update
 # For SLE:
 $ sudo zypper update

Installing the Installer Package
*********************************

In the following commands, replace ``amdgpu-install-VERSION.{deb,rpm}`` with
the actual file name of the downloaded installer package:

.. code-block:: bash

 $ cd ~/Downloads
 # For Ubuntu:
 $ sudo apt-get install ./amdgpu-install-VERSION.deb
 $ sudo apt-get update
 # For RHEL:
 $ sudo yum install ./amdgpu-install-VERSION.rpm
 # For SLE:
 $ sudo zypper install ./amdgpu-install-VERSION.rpm

.. note:: Installing "amdgpu-install" will add the installer and AMD related
   repositories to your system. The repositories will be accessible to the
   system package manager, which is in turn used by the installer.