KhronosGroup / KhronosGroup/SYCL_Reference

Synchronization and atomics chapter desing

Open
#124 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
31
Forks
26
PR merge metrics
No merged PRs in 30d

Description

Currently, the "Atomic Operations" chapter looks like this:
![image](https://github.com/KhronosGroup/SYCL_Reference/assets/122783909/632e6164-82dc-43b9-a5b7-0bcfd31efafb)

We propose to rename this chapter to "Synchronization and atomics" and implement the following structure:

- Synchronization and atomics
- Barriers and fences ([4.15.1. Barriers and fences](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#sec:barriers-fences))
- ``sycl::device_event `` ([4.15.2. device_event class](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#sec:barriers-fences))
- Atomic references ([4.15.3. Atomic references](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#sec:atomic-references))
- Interaction with host code ([4.15.5. Interaction with host code](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#_interaction_with_host_code))

Also, should we include deprecated [Atomic types](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#sec:atom-types-depr) in the reference guide?

We will create the PR with updates soon. Feel free to comment if you have any suggestions on the structure.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start from the current "Atomic Operations" chapter and compare its organization with the linked SYCL specification sections on barriers, device_event, atomic references, and host interaction. Done means renaming the chapter, applying the proposed subsection structure, and resolving whether deprecated Atomic types belong in the reference guide.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.