From 9a8ed9f45d8ff233f4cfa3916b117c68f1512dae Mon Sep 17 00:00:00 2001 From: Dominic Widdows Date: Fri, 12 Dec 2025 13:21:42 -0800 Subject: [PATCH] Doc updates updating internal links from deprecated repos to rocm-systems project locations (#2294) * Update README documentation links for clarity and consistency across projects - Changed links in the README files for `clr`, `hipother`, and `hip-tests` to use relative paths instead of absolute URLs, improving navigation within the repository. * Update CONTRIBUTING documentation to use relative links for improved navigation - Changed absolute URLs to relative paths in the CONTRIBUTING.md files for the hip and hipother projects, enhancing consistency and ease of access within the repository. --- projects/clr/README-doc.md | 6 +++--- projects/hip-tests/README-doc.md | 2 +- projects/hip/CONTRIBUTING.md | 8 ++++---- projects/hipother/CONTRIBUTING.md | 8 ++++---- projects/hipother/README-doc.md | 2 +- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/projects/clr/README-doc.md b/projects/clr/README-doc.md index c6c7cd0e11..80407772d7 100644 --- a/projects/clr/README-doc.md +++ b/projects/clr/README-doc.md @@ -4,9 +4,9 @@ AMD CLR (Compute Language Runtime) contains source codes for AMD's compute langu ## Project Organisation -- `hipamd` - contains implementation of `HIP` language on AMD platform. It is hosted at [ROCm/clr/hipamd](https://github.com/ROCm/clr/tree/develop/hipamd) -- `opencl` - contains implementation of [OpenCL™](https://www.khronos.org/opencl/) on AMD platform. Now it is hosted at [ROCm/clr/opencl](https://github.com/ROCm/clr/tree/develop/opencl) -- `rocclr` - contains compute runtime used in `HIP` and `OpenCL™`. This is hosted at [ROCm/clr/rocclr](https://github.com/ROCm/clr/tree/develop/rocclr) +- `hipamd` - contains implementation of `HIP` language on AMD platform. It is hosted at [hipamd](./hipamd) +- `opencl` - contains implementation of [OpenCL™](https://www.khronos.org/opencl/) on AMD platform. Now it is hosted at [opencl](./opencl) +- `rocclr` - contains compute runtime used in `HIP` and `OpenCL™`. This is hosted at [rocclr](./rocclr) ## How to build/install diff --git a/projects/hip-tests/README-doc.md b/projects/hip-tests/README-doc.md index 066abd52e9..0d1574dda7 100644 --- a/projects/hip-tests/README-doc.md +++ b/projects/hip-tests/README-doc.md @@ -1,6 +1,6 @@ ## What is this repository for? ### -This repository provides unit tests for [HIP](https://github.com/ROCm/HIP) implementation. +This repository provides unit tests for [HIP](../hip) implementation. ## DISCLAIMER diff --git a/projects/hip/CONTRIBUTING.md b/projects/hip/CONTRIBUTING.md index c16a15bff8..87a29256ec 100644 --- a/projects/hip/CONTRIBUTING.md +++ b/projects/hip/CONTRIBUTING.md @@ -31,14 +31,14 @@ Some guidelines are outlined below: * Add a translation to the hipify-clang tool ; many examples abound. * For stat tracking purposes, place the API into an appropriate stat category ("dev", "mem", "stream", etc). -* Add a inlined NVIDIA implementation for the function in /hipnv/include/hip/nvidia_detail/nvidia_hip_runtime_api.h in the repository [hipother](https://github.com/ROCm/hipother). +* Add a inlined NVIDIA implementation for the function in /hipnv/include/hip/nvidia_detail/nvidia_hip_runtime_api.h in the repository [hipother](../hipother). * These are typically headers -* Add an HIP definition and Doxygen comments for the function in /include/hip/hip_runtime_api.h, in the repository [hip](https://github.com/ROCm/hip). - * Source implementation typically go in clr/hipamd/src/hip_*.cpp in the reposotory [clr](https://github.com/ROCm/clr). The implementation involves calls to HIP runtime (ie for hipStream_t). +* Add an HIP definition and Doxygen comments for the function in /include/hip/hip_runtime_api.h, in the hip repository. + * Source implementation typically go in clr/hipamd/src/hip_*.cpp in the repository [clr](../clr). The implementation involves calls to HIP runtime (ie for hipStream_t). ### Run Unit Tests ### -For new features or bug fixes, it's mandatory to run associate [hip-tests](https://github.com/ROCm/hip-tests). +For new features or bug fixes, it's mandatory to run associate [hip-tests](../hip-tests). Please go to the repo and follow the steps. For applications and benchmarks outside the hip-tests environment, developments should use a two-step development flow: diff --git a/projects/hipother/CONTRIBUTING.md b/projects/hipother/CONTRIBUTING.md index 9884640b33..719e302cc7 100644 --- a/projects/hipother/CONTRIBUTING.md +++ b/projects/hipother/CONTRIBUTING.md @@ -31,14 +31,14 @@ Some guidelines are outlined below: - Add a translation to the hipify-clang tool ; many examples abound. - For stat tracking purposes, place the API into an appropriate stat category ("dev", "mem", "stream", etc). -- Add a inlined NVIDIA implementation for the function in /hipnv/include/hip/nvidia_detail/nvidia_hip_runtime_api.h in the repository [hipother](https://github.com/ROCm/hipother). +- Add a inlined NVIDIA implementation for the function in /hipnv/include/hip/nvidia_detail/nvidia_hip_runtime_api.h in the hipother repository. - These are typically headers -- Add an HIP definition and Doxygen comments for the function in /include/hip/hip_runtime_api.h, in the repository [hip](https://github.com/ROCm/hip). - - Source implementation typically go in clr/hipamd/src/hip_*.cpp in the reposotory [clr](https://github.com/ROCm/clr). The implementation involves calls to HIP runtime (ie for hipStream_t). +- Add an HIP definition and Doxygen comments for the function in /include/hip/hip_runtime_api.h, in the repository [hip](../hip). + - Source implementation typically go in clr/hipamd/src/hip_*.cpp in the repository [clr](../clr). The implementation involves calls to HIP runtime (ie for hipStream_t). ### Run Unit Tests ### -For new features or bug fixes, it's mandatory to run associate [hip-tests](https://github.com/ROCm/hip-tests) on both AMD and NVIDIA platforms. +For new features or bug fixes, it's mandatory to run associate [hip-tests](../hip-tests) on both AMD and NVIDIA platforms. Please go to the repo and follow the steps. For applications and benchmarks outside the hip-tests environment, developments should use a two-step development flow: diff --git a/projects/hipother/README-doc.md b/projects/hipother/README-doc.md index c89c90f61c..d6931e0554 100644 --- a/projects/hipother/README-doc.md +++ b/projects/hipother/README-doc.md @@ -1,6 +1,6 @@ ## What is this repository for? ### -This repository provides files required to support non-AMD specific back-end implementation for [HIP](https://github.com/ROCm/HIP). +This repository provides files required to support non-AMD specific back-end implementation for [HIP](../hip). ## DISCLAIMER