From 25c4b9584f2cf4a99064ce615fcd09dd68f4f2a2 Mon Sep 17 00:00:00 2001 From: Kiriti Gowda Date: Tue, 16 Apr 2024 15:05:17 -0700 Subject: [PATCH] Docs - Cleanup & Fix (#316) --- .jenkins/common.groovy | 1 - CHANGELOG.md | 13 ++++++++----- CMakeLists.txt | 1 + README.md | 10 +++++----- docs/install/install.rst | 12 +++++++----- 5 files changed, 21 insertions(+), 16 deletions(-) diff --git a/.jenkins/common.groovy b/.jenkins/common.groovy index 1828af666a..f2b559ad9f 100644 --- a/.jenkins/common.groovy +++ b/.jenkins/common.groovy @@ -67,7 +67,6 @@ def runTestCommand (platform, project) { """ platform.runCommand(this, command) -// Unit tests - TBD } def runPackageCommand(platform, project) { diff --git a/CHANGELOG.md b/CHANGELOG.md index 53e021a6e0..f50a46e0d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,13 +24,16 @@ Documentation for rocDecode is available at ### Tested configurations -* Linux distribution +* Linux * Ubuntu - `20.04` / `22.04` + * RHEL - `8` / `9` * ROCm: - * rocm-core - `6.1.0.60100-28` - * amdgpu-core - `1:6.1.60100-1731559` -* FFMPEG - `4.2.7` / `4.4.2-0` -* rocDecode Setup Script - `V1.7.1` + * rocm-core - `6.1.0.60100-64` + * amdgpu-core - `1:6.1.60100-1741643` +* libva-dev - `2.7.0-2` / `2.14.0-1` +* mesa-amdgpu-va-drivers - `1:24.1.0` +* FFmpeg - `4.2.7` / `4.4.2-0` +* rocDecode Setup Script - `V1.7.2` ## rocDecode 0.5.0 diff --git a/CMakeLists.txt b/CMakeLists.txt index cedb897d50..ecbe3b9c97 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -169,6 +169,7 @@ if(HIP_FOUND AND Libva_FOUND) set(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH}) set(CPACK_PACKAGE_VERSION "${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}") set(CPACK_PACKAGE_LICENSE "MIT") + # TBD: Change to generic support email set(CPACK_PACKAGE_CONTACT "rocDecode Support ") set(CPACK_PACKAGE_VENDOR "AMD ROCm") set(CPACK_PACKAGE_GROUP "Development/Tools") diff --git a/README.md b/README.md index 82f7a7edf9..b0838e0627 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ access the video decoding features available on your GPU. > [!IMPORTANT] > `sudo amdgpu-install --usecase=rocm` -* [Video Acceleration API](https://en.wikipedia.org/wiki/Video_Acceleration_API) Version `1.5.0`+ - `Libva` is an implementation for VA-API +* [Video Acceleration API](https://en.wikipedia.org/wiki/Video_Acceleration_API) Version `1.5.0+` - `Libva` is an implementation for VA-API ```shell sudo apt install libva-dev ``` @@ -69,9 +69,7 @@ access the video decoding features available on your GPU. ### Prerequisites setup script -For your convenience, we provide the setup script, -[rocDecode-setup.py](https://github.com/ROCm/rocDecode/blob/develop/rocDecode-setup.py), -which installs all required dependencies. Run this script only once. +For your convenience, we provide the setup script, [rocDecode-setup.py](https://github.com/ROCm/rocDecode/blob/develop/rocDecode-setup.py), which installs all required dependencies. Run this script only once. ```shell python3 rocDecode-setup.py --rocm_path [ ROCm Installation Path - optional (default:/opt/rocm)] @@ -86,7 +84,7 @@ The installation process uses the following steps: * Install ROCm `6.1.0` or later with [amdgpu-install](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html) with `--usecase=rocm` -* Use either [Package install](#package-install) or [Source install](#source-install) as described below. +* Use **either** [package install](#package-install) **or** [source install](#source-install) as described below. ### Package install @@ -228,5 +226,7 @@ page. * ROCm: * rocm-core - `6.1.0.60100-64` * amdgpu-core - `1:6.1.60100-1741643` +* libva-dev - `2.7.0-2` / `2.14.0-1` +* mesa-amdgpu-va-drivers - `1:24.1.0` * FFmpeg - `4.2.7` / `4.4.2-0` * rocDecode Setup Script - `V1.7.2` diff --git a/docs/install/install.rst b/docs/install/install.rst index f5e95ea3fb..c49d3c4912 100644 --- a/docs/install/install.rst +++ b/docs/install/install.rst @@ -16,13 +16,16 @@ Tested configurations * Ubuntu: 20.04/22.04 * RHEL: 8/9 - * SLES: 15-SP4 * ROCm * rocm-core: 6.1.0.60100-28 * amdgpu-core: 1:6.1.60100-1731559 +* libva-dev: 2.7.0-2/2.14.0-1 + +* mesa-amdgpu-va-drivers: 1:24.1.0 + * FFmpeg: 4.2.7/4.4.2-0 * rocDecode Setup Script: V1.7.2 @@ -39,7 +42,6 @@ Prerequisites * Ubuntu: 20.04/22.04 * RHEL: 8/9 - * SLES: 15-SP4 * `ROCm-supported hardware `_ (``gfx908`` or higher is required) @@ -54,19 +56,19 @@ Prerequisites .. code:: shell - sudo apt install libva-dev + sudo apt install libva-dev * AMD VA drivers .. code:: shell - sudo apt install mesa-amdgpu-va-drivers + sudo apt install mesa-amdgpu-va-drivers * CMake 3.5 or later .. code:: shell - sudo apt install cmake + sudo apt install cmake * `pkg-config `_