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

[DOC]: barrier_arrive_tx docs need to specify how the count is updated #1146

Closed
1 task done
gonzalobg opened this issue Nov 23, 2023 · 0 comments · Fixed by #1147
Closed
1 task done

[DOC]: barrier_arrive_tx docs need to specify how the count is updated #1146

gonzalobg opened this issue Nov 23, 2023 · 0 comments · Fixed by #1147
Labels
doc Documentation-related items.

Comments

@gonzalobg
Copy link
Collaborator

gonzalobg commented Nov 23, 2023

Is this a duplicate?

Is this for new documentation, or an update to existing docs?

New

Describe the incorrect/future/missing documentation

Instead of:

Arrives at a barrier in shared memory, updating both the arrival count and transaction count.

should say:

Arrives at a barrier in shared memory, decrementing the arrival count by arrive_count_update and incrementing the expected transaction count by transaction_count_update`.

This is covered in the effects but the summary should cover it to, since this API only arrives at the arrive-count; it does not "arrive" at the tx-count (complete-tx), it performs an expect-tx op on the tx-count.

If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

...

@gonzalobg gonzalobg added the doc Documentation-related items. label Nov 23, 2023
@github-project-automation github-project-automation bot moved this to Todo in CCCL Nov 23, 2023
@cccl-authenticator-app cccl-authenticator-app bot moved this from Todo to In Review in CCCL Nov 23, 2023
@github-project-automation github-project-automation bot moved this from In Review to Done in CCCL Nov 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related items.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant