Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SWDEV-427628 - Documentation restructure #3405

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,7 @@ build:
apt_packages:
- "doxygen"
- "graphviz" # For dot graphs in doxygen
jobs:
post_checkout:
- 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
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Contributor Guidelines
# Contributor guidelines

## Make Tips
`ROCM_PATH` is path where ROCM is installed. BY default `ROCM_PATH` is `/opt/rocm`.
If you want to contribute to the HIP project, review the following guidelines. If you want to contribute
to our documentation, refer to {doc}`Contribute to ROCm docs <rocm:contribute/contributing>`.

## Make tips

`ROCM_PATH` is path where ROCm is installed. BY default `ROCM_PATH` is `/opt/rocm`.
When building HIP, you will likely want to build and install to a local user-accessible directory (rather than `<ROCM_PATH>`).
This can be easily be done by setting the `-DCMAKE_INSTALL_PREFIX` variable when running cmake. Typical use case is to
set `CMAKE_INSTALL_PREFIX` to your HIP git root, and then ensure `HIP_PATH` points to this directory. For example
Expand All @@ -15,9 +19,8 @@ export HIP_PATH=

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

## Add a new HIP API


## Adding a new HIP API
- 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 include/hip/nvidia_detail/hip_runtime_api.h.
Expand Down Expand Up @@ -68,7 +71,7 @@ To run `hip-tests` please go to the repo and follow the steps.
`hip-tests` provide a great place to develop new features alongside the associated test.

For applications and benchmarks outside the hip-tests environment, developments should use a two-step development flow:
- #1. Compile, link, and install HIP/ROCclr. See [Installation](README.md#Installation) notes.
- #1. Compile, link, and install HIP/ROCclr. See {ref}`Building the HIP runtime` notes.
- #2. Relink the target application to include changes in HIP runtime file.

## Environment Variables
Expand Down
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,6 @@

for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)

cpp_id_attributes = ["__global__", "__device__", "__host__", "__forceinline__", "static"]
cpp_paren_attributes = ["__declspec"]
200 changes: 0 additions & 200 deletions docs/developer_guide/build.md

This file was deleted.

Loading