Skip to content

Commit b484877

Browse files
committed
SWDEV-427628 - Documentation restructure
Upstream of documentation restructure and adds some of the absent math and async function documentation. Change-Id: Ia7a6fbe053afe85015b04e20a610115be3c664af
1 parent 310b089 commit b484877

25 files changed

+3515
-5881
lines changed

docs/developer_guide/contributing.md renamed to docs/about/contributing.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
# Contributor Guidelines
1+
# Contributor guidelines
22

3-
## Make Tips
4-
`ROCM_PATH` is path where ROCM is installed. BY default `ROCM_PATH` is `/opt/rocm`.
3+
If you want to contribute to the HIP project, review the following guidelines. If you want to contribute
4+
to our documentation, refer to {doc}`Contribute to ROCm docs <rocm:conribute/index>`.
5+
6+
## Make tips
7+
8+
`ROCM_PATH` is path where ROCm is installed. BY default `ROCM_PATH` is `/opt/rocm`.
59
When building HIP, you will likely want to build and install to a local user-accessible directory (rather than `<ROCM_PATH>`).
610
This can be easily be done by setting the `-DCMAKE_INSTALL_PREFIX` variable when running cmake. Typical use case is to
711
set `CMAKE_INSTALL_PREFIX` to your HIP git root, and then ensure `HIP_PATH` points to this directory. For example
@@ -15,9 +19,8 @@ export HIP_PATH=
1519

1620
After making HIP, don't forget the "make install" step !
1721

22+
## Add a new HIP API
1823

19-
20-
## Adding a new HIP API
2124
- Add a translation to the hipify-clang tool ; many examples abound.
2225
- For stat tracking purposes, place the API into an appropriate stat category ("dev", "mem", "stream", etc).
2326
- Add a inlined NVIDIA implementation for the function in include/hip/nvidia_detail/hip_runtime_api.h.

docs/developer_guide/build.md

Lines changed: 0 additions & 200 deletions
This file was deleted.

0 commit comments

Comments
 (0)