Commit e081de57 authored by Jeremy Newton's avatar Jeremy Newton
Browse files

Merge branch 'vulkan-radv-update' into 'master'

doc: replace deprecated Vulkan options with RADV

See merge request !14
parents 220e4d26 b719b52b
Loading
Loading
Loading
Loading
+10 −12
Changes for source/install-script.rst: 10 added lines, 12 removed lines.
Original line number Diff line number Diff line
@@ -38,7 +38,7 @@ Scenarios
Specifying an OpenCL Implementation
-----------------------------------

There is currently only one OpenCL implementations available:
There is currently only one OpenCL implementation available:

- **ROCr**: Provides support for *Vega 10* and newer hardware.

@@ -61,27 +61,25 @@ OpenCL is installed using the ``--opencl`` option, as follows:
Specifying a Vulkan Implementation
-----------------------------------

There are two Vulkan implementations available:
There is currently only one Vulkan implementation available:

- **AMDVLK**: Provides open source Vulkan
- **PRO**: Provides PRO vulkan (**Proprietary**, requires EULA acceptance)

You can either install one or both implementations.
- **RADV**: Provides the open source Mesa Vulkan driver.

Vulkan is installed using the ``--vulkan`` option, as follows:

+------------------------+---------------------------------------------+
|**Option**              | **Description**                             |
+------------------------+---------------------------------------------+
|``--vulkan=amdvlk``     | Installs open source Vulkan                 |
+------------------------+---------------------------------------------+
|``--vulkan=pro``        | Installs PRO Vulkan (**Proprietary**)       |
+------------------------+---------------------------------------------+
|``--vulkan=amdvlk,pro`` | Installs both open and PRO Vulkan.          |
|``--vulkan=radv``       | Installs open source Vulkan (RADV).         |
+------------------------+---------------------------------------------+

.. note:: The ``amdvlk`` and ``pro`` options have been removed. Use
      ``radv`` instead.


Viewing Help or Usage Output
-----------------------------

Executing the script with ``-h`` or ``--help`` argument provides the help or
usage output.

@@ -99,4 +97,4 @@ script with arguments to pass through to the package management software of the
distribution you are using.

- On Ubuntu, refer to the `apt man page <https://linux.die.net/man/8/apt>`_ for more information.
- On Red Hat, refer to `yum man page <https://linux.die.net/man/8/yum>`_ for more information.
- On Red Hat, refer to the `yum man page <https://linux.die.net/man/8/yum>`_ for more information.