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

libcore docs should mention that some atomic operations may not be available #54250

Closed
mvirkkunen opened this issue Sep 15, 2018 · 0 comments · Fixed by #72998
Closed

libcore docs should mention that some atomic operations may not be available #54250

mvirkkunen opened this issue Sep 15, 2018 · 0 comments · Fixed by #72998
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. P-medium Medium priority T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.

Comments

@mvirkkunen
Copy link

mvirkkunen commented Sep 15, 2018

A number of atomic operations such as AtomicUsize::compare_exchange are simply missing on some platforms such as thumbv6m-none-eabi. The methods are behind this condition:

#[cfg(target_has_atomic = "cas")]

It's understandable that these methods aren't available on platforms that don't support compare-and-swap in hardware. However the documentation doesn't mention that at all, which might lead to people assuming that the functionality is available on all platforms. I think the documentation should clearly mention which parts of libcore may be unavailable depending on the platform.

@zackmdavis zackmdavis added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Sep 15, 2018
@steveklabnik steveklabnik added the P-medium Medium priority label Dec 27, 2018
@jonas-schievink jonas-schievink added C-enhancement Category: An issue proposing an enhancement or a PR with one. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. labels Mar 6, 2020
@bors bors closed this as completed in de1941a Jun 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. P-medium Medium priority T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants