update Atomic*::from_ptr and Atomic*::as_ptr docs
#144072
Open
+15
−9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
rustbot has assigned @Mark-Simulacrum. Use |
rustbot
added
S-waiting-on-review
library/core/src/sync/atomic.rs
Outdated
| @@ -1246,7 +1246,7 @@ impl AtomicBool { | |||
| /// atomic types work with interior mutability. All modifications of an atomic change the value | |||
| /// through a shared reference, and can do so safely as long as they use atomic operations. Any | |||
| /// use of the returned raw pointer requires an `unsafe` block and still has to uphold the same | |||
| /// restriction: operations on it must be atomic. | |||
| /// restriction: no data races and no mixed-size accesses. | |||
There was a problem hiding this comment.
Can we instead alter this to point at the memory model section that has more words about this? I like the wording in the from_ptr methods.
There was a problem hiding this comment.
It's restriction in [Memory model for atomic accesses]. now.
@rustbot ready
Mark-Simulacrum
added
S-waiting-on-author
rustbot
added
S-waiting-on-review
rustbot
removed
the
S-waiting-on-review
rustbot
added
the
S-waiting-on-review
|
@bors r+ |
bors
added
S-waiting-on-bors
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Jul 28, 2025
update `Atomic*::from_ptr` and `Atomic*::as_ptr` docs Since rust-lang#128778, it's allowed to perform atomic read and non-atomic read on the same atomic at the same time. Update the `Atomic*::from_ptr` and `Atomic*::as_ptr` documentation to remove expressions such as `not allowed to mix atomic and non-atomic accesses`. see also [std::sync::atomic](https://doc.rust-lang.org/std/sync/atomic/index.html#memory-model-for-atomic-accesses)
bors
added a commit
that referenced
this pull request
Jul 28, 2025
Rollup of 7 pull requests Successful merges: - #144072 (update `Atomic*::from_ptr` and `Atomic*::as_ptr` docs) - #144151 (`tests/ui/issues/`: The Issues Strike Back [1/N]) - #144300 (Clippy fixes for miropt-test-tools) - #144399 (Add a ratchet for moving all standard library tests to separate packages) - #144472 (str: Mark unstable `round_char_boundary` feature functions as const) - #144503 (Various refactors to the codegen coordinator code (part 3)) - #144530 (coverage: Infer `instances_used` from `pgo_func_name_var_map`) r? `@ghost` `@rustbot` modify labels: rollup
RalfJung
reviewed
Jul 28, 2025
| @@ -1246,7 +1246,7 @@ impl AtomicBool { | |||
| /// atomic types work with interior mutability. All modifications of an atomic change the value | |||
| /// through a shared reference, and can do so safely as long as they use atomic operations. Any | |||
| /// use of the returned raw pointer requires an `unsafe` block and still has to uphold the same | |||
| /// restriction: operations on it must be atomic. | |||
| /// restriction in [Memory model for atomic accesses]. | |||
There was a problem hiding this comment.
This doesn't sound like a sentence to me? "restriction in Memory model" is not grammatical, and also oddly capitalized.
There was a problem hiding this comment.
It's a title, so I thought it was appropriate to preserve the capitalization. The existing documentation for from_ptr uses You must adhere to the [Memory model for atomic accesses] and also uses capital letters.
Do you have any suggestions?
|
(This got rolled-up so fixing the wording might need a new PR) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since #128778, it's allowed to perform atomic read and non-atomic read on the same atomic at the same time. Update the
Atomic*::from_ptrandAtomic*::as_ptrdocumentation to remove expressions such asnot allowed to mix atomic and non-atomic accesses.see also std::sync::atomic