oneapi-src / oneapi-src/level-zero
Explicitly tell users how to include ze_api.h and friends.
Nessuno ha ancora preso questa issue.
- Lingua principale
- C++
- Stelle
- 335
- Fork
- 140
- Merge medio
- 12h 32m
- PR unite (30g)
- 5
Descrizione
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?)
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia leggendo CMakeLists.txt, la documentazione ABI e la discussione relativa agli include nella issue #50. Chiarisci se gli utenti debbano includere <level_zero/ze_api.h> o <ze_api.h>, quindi documenta la convenzione scelta e assicurati che le indicazioni sugli include corrispondano alla disposizione degli header installati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- cmake, cpp
- Ambito
- build-system, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100