Programming interface

.github/dependabot.yml

@@ -14,5 +14,6 @@ updates:
       - "documentation"
       - "dependencies"
       - "ci:docs-only"
+    target-branch: "docs/develop"
     reviewers:
       - "samjwu"

.readthedocs.yaml

@@ -6,28 +6,28 @@ version: 2
 sphinx:
    configuration: docs/conf.py
 
-formats: [htmlzip, pdf, epub]
+formats: []
 
 python:
    install:
    - requirements: docs/sphinx/requirements.txt
 
+conda:
+   environment: docs/environment.yml # needed until ubuntu ships doxygen >= 1.9.8
+
 build:
    os: ubuntu-22.04
    tools:
-      python: "3.10"
+      python: "mambaforge-22.9" # needed until ubuntu ships doxygen >= 1.9.8
    apt_packages:
-     - "doxygen"
+     - "gfortran" # For pre-processing fortran sources
      - "graphviz" # For dot graphs in doxygen
    jobs:
      post_checkout:
-       - if [ -d ../llvm-project ]; then rmdir ../llvm-project; fi
-       - if [ -d ../clr ]; then rmdir ../clr; fi
-       - if [ -d ../ROCR-Runtime ]; then rmdir ../ROCR-Runtime; fi
-       - git clone --depth=1 --single-branch --branch rocdoc-195 https://github.com/StreamHPC/llvm-project.git ../llvm-project
-       - git clone --depth=1 --single-branch --branch develop    https://github.com/ROCm/clr.git ../clr
-       - git clone --depth=1 --single-branch --branch master     https://github.com/ROCm/ROCR-Runtime.git ../ROCR-Runtime
+       - if [ -d ../clr ]; then rm -rf ../clr; fi
+       - if [ -d ../ROCR-Runtime ]; then rm -rf ../ROCR-Runtime; fi
+       - git clone --depth=1 --single-branch --branch docs/develop https://github.com/ROCm/clr.git ../clr
+       - git clone --depth=1 --single-branch --branch master       https://github.com/ROCm/ROCR-Runtime.git ../ROCR-Runtime
      post_build:
        - rm -rf ../clr
-       - rm -rf ../llvm-project
        - rm -rf ../ROCR-Runtime

.wordlist.txt

@@ -2,7 +2,9 @@ ALU
 ALUs
 AmgX
 APU
+APUs
 AQL
+AXPY
 Asynchrony
 backtrace
 Bitcode
@@ -12,24 +14,33 @@ builtins
 Builtins
 CAS
 clr
+coroutines
 cuBLASLt
 cuCtx
+CUDA's
 cuDNN
+dataflow
 deallocate
+decompositions
 denormal
+Dereferencing
 dll
 DirectX
 EIGEN
 EIGEN's
 enqueue
 enqueues
+entrypoint
+entrypoints
 enum
 embeded
 extern
 fatbinary
+foundationally
 frontends
 gedit
 GPGPU
+GWS
 hardcoded
 HC
 HIP's
@@ -40,12 +51,17 @@ hipother
 HIPRTC
 hcBLAS
 icc
+IILE
+iGPU
+inlined
 inplace
+interop
 Interoperation
 interoperate
 Intrinsics
 intrinsics
 IPC
+IPs
 isa
 Lapack
 latencies
@@ -62,31 +78,47 @@ malloc
 multicore
 multigrid
 multithreading
+MALU
 NCCL
 NDRange
 nonnegative
+NOP
 Numa
 Nsight
+overindex
+overindexing
 oversubscription
+pragmas
 preconditioners
 prefetched
 preprocessor
 PTX
 PyHIP
 queryable
+prefetching
+readonly
 representable
 RMW
 ROCm's
 rocTX
 RTC
 RTTI
+rvalue
+SAXPY
 scalarizing
 sceneries
+shaders
 SIMT
+SOMA
 SPMV
 structs
 SYCL
 syntaxes
+tradeoffs
+templated
 typedefs
+UMM
+unmap
+variadic
 WinGDB
-zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz

README.md

@@ -37,7 +37,7 @@ HIP releases are typically naming convention for each ROCM release to help diffe
 
 * [Installation](docs/install/install.rst)
 * [HIP FAQ](docs/how-to/faq.md)
-* [HIP Kernel Language](docs/reference/kernel_language.rst)
+* [HIP C++ Language Extensions](docs/reference/cpp_language_extensions.rst)
 * [HIP Porting Guide](docs/how-to/hip_porting_guide.md)
 * [HIP Porting Driver Guide](docs/how-to/hip_porting_driver_api.md)
 * [HIP Programming Guide](docs/how-to/programming_manual.md)
@@ -88,7 +88,7 @@ hipMemcpy(C_h, C_d, Nbytes, hipMemcpyDeviceToHost);
 
 The HIP kernel language defines builtins for determining grid and block coordinates, math functions, short vectors,
 atomics, and timer functions.
-It also specifies additional defines and keywords for function types, address spaces, and optimization controls (See the [HIP Kernel Language](docs/reference/kernel_language.rst) for a full description).
+It also specifies additional defines and keywords for function types, address spaces, and optimization controls (See the [HIP C++ Language Extensions](docs/reference/cpp_language_extensions.rst) for a full description).
 Here's an example of defining a simple 'vector_square' kernel.
 
 ```cpp

docs/.gitignore

@@ -5,4 +5,4 @@
 /_templates
 /doxygen/html
 /doxygen/xml
-/sphinx/_toc.yml
+/sphinx/_toc.yml

docs/conf.py

@@ -43,4 +43,11 @@
 cpp_id_attributes = ["__global__", "__device__", "__host__", "__forceinline__", "static"]
 cpp_paren_attributes = ["__declspec"]
 
-suppress_warnings = ["etoc.toctree"]
+suppress_warnings = ["etoc.toctree"]
+
+numfig = False
+
+exclude_patterns = [
+    "doxygen/mainpage.md",
+    "understand/glossary.md"
+]