oneapi-src / oneapi-src/level-zero
Explicitly tell users how to include ze_api.h and friends.
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 335
- Forks
- 140
- Avg merge
- 12h 32m
- Merged PRs (30d)
- 5
Description
The CMakeLists.txt file suggests that the main headers are installed to <prefix>/include/level_zero/ which would imply that users should #include <level_zero/ze_api.h> instead of #include <ze_api.h>. However, the documentation (https://spec.oneapi.com/level-zero/latest/core/INTRO.html#application-binary-interface) states that users should just include "ze_api.h".
Can we make a concrete statement in the documentation about how to include <level_zero/ze_api.h> instead of <ze_api.h>?
This also brings into question how the include parts of #50 should be structured (basically should we remove the level_zero component of the include?)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading CMakeLists.txt, the ABI documentation, and the include-related discussion in issue #50. Clarify whether users should include <level_zero/ze_api.h> or <ze_api.h>, then document the chosen convention and ensure the include guidance matches the installed header layout.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cmake, cpp
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100