Update documentation requirements

Require build.os

.readthedocs.yaml

@@ -3,12 +3,19 @@
 
 version: 2
 
+build:
+   os: ubuntu-22.04
+   tools:
+      python: "3.10"
+   apt_packages:
+     - "doxygen"
+     - "graphviz" # For dot graphs in doxygen
+
+python:
+   install:
+   - requirements: docs/sphinx/requirements.txt
+
 sphinx:
    configuration: docs/conf.py
 
-formats: [htmlzip, pdf, epub]
-
-python:
-   version: "3.8"
-   install:
-   - requirements: docs/sphinx/requirements.txt
+formats: []

CHANGELOG.md

@@ -44,6 +44,29 @@ The following hipcc changes are implemented in this release:
   - `hipCommander` at <https://github.com/ROCm-Developer-Tools/hip-tests/tree/develop/samples/1_Utils/hipCommander>
 
   Note that the samples will continue to be available in previous release branches.
+- Removal of gcnarch from hipDeviceProp_t structure
+- Addition of new fields in hipDeviceProp_t structure
+  - maxTexture1D
+  - maxTexture2D
+  - maxTexture1DLayered
+  - maxTexture2DLayered
+  - sharedMemPerMultiprocessor
+  - deviceOverlap
+  - asyncEngineCount
+  - surfaceAlignment
+  - unifiedAddressing
+  - computePreemptionSupported
+  - hostRegisterSupported
+  - uuid
+- Removal of deprecated code
+  - hip-hcc codes from hip code tree
+- Correct hipArray usage in HIP APIs such as hipMemcpyAtoH and hipMemcpyHtoA
+- HIPMEMCPY_3D fields correction to avoid truncation of "size_t" to "unsigned int" inside hipMemcpy3D()
+- Renaming of 'memoryType' in hipPointerAttribute_t structure to 'type'
+- Correct hipGetLastError to return the last error instead of last API call's return code
+- Update hipExternalSemaphoreHandleDesc to add "unsigned int reserved[16]"
+- Correct handling of flag values in hipIpcOpenMemHandle for hipIpcMemLazyEnablePeerAccess
+- Remove hiparray* and make it opaque with hipArray_t
 
 ##### New HIP APIs in This Release
 

docs/conf.py

@@ -14,12 +14,25 @@ shutil.copy2('../RELEASE.md','./release.md')
 # Keep capitalization due to similar linking on GitHub's markdown preview.
 shutil.copy2('../CHANGELOG.md','./CHANGELOG.md')
 
+# configurations for PDF output by Read the Docs
+project = "ROCm Documentation"
+author = "Advanced Micro Devices, Inc."
+copyright = "Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved."
+version = "5.5.0"
+release = "5.5.0"
+
 setting_all_article_info = True
 all_article_info_os = ["linux"]
 all_article_info_author = ""
 
 # pages with specific settings
 article_pages = [
+    {
+        "file":"release",
+        "os":["linux"],
+        "date":"2023-05-01"
+    },
+
     {"file":"deploy/linux/index", "os":["linux"]},
     {"file":"deploy/linux/install_overview", "os":["linux"]},
     {"file":"deploy/linux/prerequisites", "os":["linux"]},
@@ -57,7 +70,7 @@ article_pages = [
 
 external_toc_path = "./sphinx/_toc.yml"
 
-docs_core = ROCmDocs("ROCm Documentation Home")
+docs_core = ROCmDocs("ROCm 5.5.0 Documentation Home")
 docs_core.setup()
 
 external_projects_current_project = "rocm"

docs/deploy/linux/quick_start.md

@@ -29,11 +29,11 @@ wget https://repo.radeon.com/rocm/rocm.gpg.key -O - | \
 ```shell
 # Kernel driver repository for focal
 sudo tee /etc/apt/sources.list.d/amdgpu.list <<'EOF'
-deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/latest/ubuntu focal main
+deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/5.5/ubuntu focal main
 EOF
 # ROCm repository for focal
 sudo tee /etc/apt/sources.list.d/rocm.list <<'EOF'
-deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/debian focal main
+deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/5.5 focal main
 EOF
 ```
 
@@ -44,13 +44,15 @@ EOF
 ```shell
 # Kernel driver repository for jammy
 sudo tee /etc/apt/sources.list.d/amdgpu.list <<'EOF'
-deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/latest/ubuntu jammy main
+deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/5.5/ubuntu jammy main
 EOF
 # ROCm repository for jammy
 sudo tee /etc/apt/sources.list.d/rocm.list <<'EOF'
-deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/debian jammy main
-echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
+deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/5.5 jammy main
 EOF
+
+# Prefer packages from the rocm repository over system packages
+echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
 ```
 
 :::
@@ -80,7 +82,7 @@ sudo apt update
 sudo tee /etc/yum.repos.d/amdgpu.repo <<'EOF'
 [amdgpu]
 name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/latest/rhel/8.6/main/x86_64
+baseurl=https://repo.radeon.com/amdgpu/5.5/rhel/8.6/main/x86_64
 enabled=1
 gpgcheck=1
 gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
@@ -89,7 +91,7 @@ EOF
 sudo tee /etc/yum.repos.d/rocm.repo <<'EOF'
 [rocm]
 name=rocm
-baseurl=https://repo.radeon.com/rocm/rhel8/latest/main
+baseurl=https://repo.radeon.com/rocm/rhel8/5.5/main
 enabled=1
 priority=50
 gpgcheck=1
@@ -107,7 +109,7 @@ EOF
 sudo tee /etc/yum.repos.d/amdgpu.repo <<'EOF'
 [amdgpu]
 name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/latest/rhel/8.7/main/x86_64
+baseurl=https://repo.radeon.com/amdgpu/5.5/rhel/8.7/main/x86_64
 enabled=1
 gpgcheck=1
 gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
@@ -116,7 +118,7 @@ EOF
 sudo tee /etc/yum.repos.d/rocm.repo <<'EOF'
 [rocm]
 name=rocm
-baseurl=https://repo.radeon.com/rocm/rhel8/latest/main
+baseurl=https://repo.radeon.com/rocm/rhel8/5.5/main
 enabled=1
 priority=50
 gpgcheck=1
@@ -134,7 +136,7 @@ EOF
 sudo tee /etc/yum.repos.d/amdgpu.repo <<'EOF'
 [amdgpu]
 name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/latest/rhel/9.1/main/x86_64
+baseurl=https://repo.radeon.com/amdgpu/5.5/rhel/9.1/main/x86_64
 enabled=1
 gpgcheck=1
 gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
@@ -143,7 +145,7 @@ EOF
 sudo tee /etc/yum.repos.d/rocm.repo <<'EOF'
 [rocm]
 name=rocm
-baseurl=https://repo.radeon.com/rocm/rhel9/latest/main
+baseurl=https://repo.radeon.com/rocm/rhel9/5.5/main
 enabled=1
 priority=50
 gpgcheck=1
@@ -179,7 +181,7 @@ sudo yum clean all
 sudo tee /etc/zypp/repos.d/amdgpu.repo <<'EOF'
 [amdgpu]
 name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/latest/sle/15.4/main/x86_64
+baseurl=https://repo.radeon.com/amdgpu/5.5/sle/15.4/main/x86_64
 enabled=1
 gpgcheck=1
 gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key

docs/reference/ai_tools.md

@@ -10,17 +10,17 @@ AMD's library for high performance machine learning primitives.
 
 :::
 
-:::{grid-item-card} {doc}`Composable Kernel <composable-kernel:index>`
+:::{grid-item-card} {doc}`Composable Kernel <composable_kernel:index>`
 Composable Kernel: Performance Portable Programming Model for Machine Learning Tensor Operators
 
-- {doc}`Documentation <composable-kernel:index>`
+- {doc}`Documentation <composable_kernel:index>`
 
 :::
 
-:::{grid-item-card} {doc}`MIGraphX <migraphx:index>`
+:::{grid-item-card} {doc}`MIGraphX <amdmigraphx:index>`
 AMD MIGraphX is AMD's graph inference engine that accelerates machine learning model inference.
 
-- {doc}`Documentation <migraphx:index>`
+- {doc}`Documentation <amdmigraphx:index>`
 
 :::
 

docs/reference/all.md

@@ -42,8 +42,8 @@ Inter and intra-node communication is supported by the following projects:
 Libraries related to AI.
 
 - {doc}`MIOpen <miopen:index>`
-- {doc}`Composable Kernel <composable-kernel:index>`
-- {doc}`MIGraphX <migraphx:index>`
+- {doc}`Composable Kernel <composable_kernel:index>`
+- {doc}`MIGraphX <amdmigraphx:index>`
 
 :::
 
@@ -80,7 +80,7 @@ Computer vision related projects.
 
 :::{grid-item-card} [Validation Tools](validation_tools)
 
-- {doc}`ROCm Validation Suite <rocm-validation-suite:index>`
+- {doc}`ROCm Validation Suite <rocmvalidationsuite:index>`
 - {doc}`TransferBench <transferbench:index>`
 
 :::

docs/reference/validation_tools.md

@@ -3,10 +3,10 @@
 :::::{grid} 1 1 2 2
 :gutter: 1
 
-:::{grid-item-card} {doc}`RVS <rocm-validation-suite:index>`
+:::{grid-item-card} {doc}`RVS <rocmvalidationsuite:index>`
 The ROCm Validation Suite is a system administrator’s and cluster manager's tool for detecting and troubleshooting common problems affecting AMD GPU(s) running in a high-performance computing environment, enabled using the ROCm software stack on a compatible platform.
 
-- {doc}`Documentation <rocm-validation-suite:index>`
+- {doc}`Documentation <rocmvalidationsuite:index>`
 
 :::
 

docs/sphinx/_toc.yml.in

@@ -148,9 +148,9 @@ subtrees:
           - title: MIOpen - Machine Intelligence
             url: ${project:miopen}
           - title: Composable Kernel
-            url: ${project:composable-kernel}
+            url: ${project:composable_kernel}
           - title: MIGraphX - Graph Optimization
-            url: ${project:migraphx}
+            url: ${project:amdmigraphx}
     - file: reference/computer_vision
       subtrees:
         - entries:
@@ -173,7 +173,7 @@ subtrees:
       title: Validation Tools
       subtrees:
         - entries:
-          - url: ${project:rocm-validation-suite}
+          - url: ${project:rocmvalidationsuite}
             title: RVS
           - url: ${project:transferbench}
             title: TransferBench

docs/sphinx/requirements.in

@@ -1 +1,2 @@
-rocm-docs-core==0.16.0
+rocm-docs-core==1.8.0
+sphinx-reredirects

docs/sphinx/requirements.txt

@@ -1,114 +1,106 @@
 #
-# This file is autogenerated by pip-compile with Python 3.11
+# This file is autogenerated by pip-compile with Python 3.10
 # by the following command:
 #
-#    pip-compile docs/sphinx/requirements.in
+#    pip-compile requirements.in
 #
-accessible-pygments==0.0.3
+accessible-pygments==0.0.5
     # via pydata-sphinx-theme
-alabaster==0.7.13
+alabaster==1.0.0
     # via sphinx
-babel==2.11.0
+babel==2.16.0
     # via
     #   pydata-sphinx-theme
     #   sphinx
-beautifulsoup4==4.11.2
+beautifulsoup4==4.12.3
     # via pydata-sphinx-theme
-breathe==4.34.0
+breathe==4.35.0
     # via rocm-docs-core
-certifi==2022.12.7
+certifi==2024.8.30
     # via requests
-cffi==1.15.1
+cffi==1.17.1
     # via
     #   cryptography
     #   pynacl
-charset-normalizer==2.1.1
+charset-normalizer==3.3.2
     # via requests
-click==8.1.3
+click==8.1.7
     # via sphinx-external-toc
-colorama==0.4.6
-    # via
-    #   click
-    #   sphinx
-cryptography==40.0.2
+cryptography==43.0.1
     # via pyjwt
-deprecated==1.2.13
+deprecated==1.2.14
     # via pygithub
-docutils==0.19
+docutils==0.21.2
     # via
     #   breathe
     #   myst-parser
     #   pydata-sphinx-theme
     #   sphinx
-fastjsonschema==2.16.3
+fastjsonschema==2.20.0
     # via rocm-docs-core
-gitdb==4.0.10
+gitdb==4.0.11
     # via gitpython
-gitpython==3.1.30
+gitpython==3.1.43
     # via rocm-docs-core
-idna==3.4
+idna==3.10
     # via requests
 imagesize==1.4.1
     # via sphinx
-jinja2==3.1.2
+jinja2==3.1.4
     # via
     #   myst-parser
     #   sphinx
-linkify-it-py==1.0.3
-    # via myst-parser
-markdown-it-py==2.2.0
+markdown-it-py==3.0.0
     # via
     #   mdit-py-plugins
     #   myst-parser
-markupsafe==2.1.2
+markupsafe==2.1.5
     # via jinja2
-mdit-py-plugins==0.3.4
+mdit-py-plugins==0.4.2
     # via myst-parser
 mdurl==0.1.2
     # via markdown-it-py
-myst-parser[linkify]==1.0.0
+myst-parser==4.0.0
     # via rocm-docs-core
-packaging==23.0
+packaging==24.1
     # via
     #   pydata-sphinx-theme
     #   sphinx
-pycparser==2.21
+pycparser==2.22
     # via cffi
-pydata-sphinx-theme==0.13.3
+pydata-sphinx-theme==0.15.4
     # via
     #   rocm-docs-core
     #   sphinx-book-theme
-pygithub==1.58.1
+pygithub==2.4.0
     # via rocm-docs-core
-pygments==2.14.0
+pygments==2.18.0
     # via
     #   accessible-pygments
     #   pydata-sphinx-theme
     #   sphinx
-pyjwt[crypto]==2.6.0
+pyjwt[crypto]==2.9.0
     # via pygithub
 pynacl==1.5.0
     # via pygithub
-pytz==2022.7.1
-    # via babel
-pyyaml==6.0
+pyyaml==6.0.2
     # via
     #   myst-parser
     #   rocm-docs-core
     #   sphinx-external-toc
-requests==2.28.1
+requests==2.32.3
     # via
     #   pygithub
     #   sphinx
-rocm-docs-core==0.16.0
-    # via -r docs/sphinx/requirements.in
-smmap==5.0.0
+rocm-docs-core==1.8.0
+    # via -r requirements.in
+smmap==5.0.1
     # via gitdb
 snowballstemmer==2.2.0
     # via sphinx
-soupsieve==2.4
+soupsieve==2.6
     # via beautifulsoup4
-sphinx==5.3.0
+sphinx==8.0.2
     # via
     #   breathe
     #   myst-parser
@@ -119,33 +111,40 @@ sphinx==5.3.0
     #   sphinx-design
     #   sphinx-external-toc
     #   sphinx-notfound-page
-sphinx-book-theme==1.0.1
+    #   sphinx-reredirects
+sphinx-book-theme==1.1.3
     # via rocm-docs-core
-sphinx-copybutton==0.5.1
+sphinx-copybutton==0.5.2
     # via rocm-docs-core
-sphinx-design==0.4.1
+sphinx-design==0.6.1
     # via rocm-docs-core
-sphinx-external-toc==0.3.1
+sphinx-external-toc==1.0.1
     # via rocm-docs-core
-sphinx-notfound-page==0.8.3
+sphinx-notfound-page==1.0.4
     # via rocm-docs-core
-sphinxcontrib-applehelp==1.0.4
+sphinx-reredirects==0.1.5
+    # via -r requirements.in
+sphinxcontrib-applehelp==2.0.0
     # via sphinx
-sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-devhelp==2.0.0
     # via sphinx
-sphinxcontrib-htmlhelp==2.0.1
+sphinxcontrib-htmlhelp==2.1.0
     # via sphinx
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
-sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-qthelp==2.0.0
     # via sphinx
-sphinxcontrib-serializinghtml==1.1.5
+sphinxcontrib-serializinghtml==2.0.0
     # via sphinx
-typing-extensions==4.5.0
-    # via pydata-sphinx-theme
-uc-micro-py==1.0.1
-    # via linkify-it-py
-urllib3==1.26.13
-    # via requests
-wrapt==1.14.1
+tomli==2.0.1
+    # via sphinx
+typing-extensions==4.12.2
+    # via
+    #   pydata-sphinx-theme
+    #   pygithub
+urllib3==2.2.3
+    # via
+    #   pygithub
+    #   requests
+wrapt==1.16.0
     # via deprecated

tools/autotag/templates/rocm_changes/5.5.0.md

@@ -26,6 +26,29 @@ The following hipcc changes are implemented in this release:
   - `hipCommander` at <https://github.com/ROCm-Developer-Tools/hip-tests/tree/develop/samples/1_Utils/hipCommander>
 
   Note that the samples will continue to be available in previous release branches.
+- Removal of gcnarch from hipDeviceProp_t structure
+- Addition of new fields in hipDeviceProp_t structure
+  - maxTexture1D
+  - maxTexture2D
+  - maxTexture1DLayered
+  - maxTexture2DLayered
+  - sharedMemPerMultiprocessor
+  - deviceOverlap
+  - asyncEngineCount
+  - surfaceAlignment
+  - unifiedAddressing
+  - computePreemptionSupported
+  - hostRegisterSupported
+  - uuid
+- Removal of deprecated code
+  - hip-hcc codes from hip code tree
+- Correct hipArray usage in HIP APIs such as hipMemcpyAtoH and hipMemcpyHtoA
+- HIPMEMCPY_3D fields correction to avoid truncation of "size_t" to "unsigned int" inside hipMemcpy3D()
+- Renaming of 'memoryType' in hipPointerAttribute_t structure to 'type'
+- Correct hipGetLastError to return the last error instead of last API call's return code
+- Update hipExternalSemaphoreHandleDesc to add "unsigned int reserved[16]"
+- Correct handling of flag values in hipIpcOpenMemHandle for hipIpcMemLazyEnablePeerAccess
+- Remove hiparray* and make it opaque with hipArray_t
 
 ##### New HIP APIs in This Release