oneapi-src / oneapi-src/unified-runtime
ur: Review & expand object lifetime descripitons
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 57
- Forks
- 120
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 1
Description
Currently we have the Device handle lifetime and the Queue object lifetime sections in the Programming Guide but we do not have an overarching description of how object lifetimes and reference counting are expected to operate.
We also need to ensure the Device handle lifetime aligns with the implementations. As its currently defined the lifetime of a device hadle differs from the OpenCL specification which gives devices static lifetime but more closely aligns with the OpenCL sub-device lifetime description.
Contributor guide
No contributing guide indexed for this repository
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 with the Programming Guide's Device handle lifetime and Queue object lifetime sections linked in the issue, then compare their stated reference-counting behavior with the implementations and the OpenCL specification. Done means the guide has an overarching object-lifetime description and the device lifetime wording is aligned with the implementation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100