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

Removed aligned ZST requirement from docs of read_/write_unaligned. #57168

Merged
merged 1 commit into from
Dec 29, 2018

Conversation

kennytm
Copy link
Member

@kennytm kennytm commented Dec 28, 2018

This is just a copy-paste error.

@rust-highfive
Copy link
Collaborator

r? @rkruppe

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 28, 2018
@hanna-kruppe
Copy link
Contributor

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Dec 28, 2018

📌 Commit 9223512 has been approved by rkruppe

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 28, 2018
kennytm added a commit to kennytm/rust that referenced this pull request Dec 29, 2018
Removed aligned ZST requirement from docs of read_/write_unaligned.

This is just a copy-paste error.
bors added a commit that referenced this pull request Dec 29, 2018
Rollup of 7 pull requests

Successful merges:

 - #57149 (Fix typo in pin documentation)
 - #57153 (Small: Fix span in char documentation)
 - #57159 (Update references to closed issue)
 - #57163 (Give the crate select chevron room to breathe.)
 - #57168 (Removed aligned ZST requirement from docs of read_/write_unaligned.)
 - #57174 (Update link to rustc guide)
 - #57177 (Fix warning when compiling rustc)

Failed merges:

r? @ghost
@bors bors merged commit 9223512 into rust-lang:master Dec 29, 2018
@RalfJung
Copy link
Member

RalfJung commented Jan 9, 2019

This forgot to update the same text in three other places. I will submit a follow-up.

In the future, please remember that all these pointer methods exist as free-standing functions, as methods on *mut, and sometimes as methods on *const. Doc fixes need to be applied to all of them.

@kennytm
Copy link
Member Author

kennytm commented Jan 9, 2019

The three inherent methods doesn't contain this paragraph.

rust/src/libcore/ptr.rs

Lines 2108 to 2122 in 0071157

/// Reads the value from `self` without moving it. This leaves the
/// memory in `self` unchanged.
///
/// Unlike `read`, the pointer may be unaligned.
///
/// See [`ptr::read_unaligned`] for safety concerns and examples.
///
/// [`ptr::read_unaligned`]: ./ptr/fn.read_unaligned.html
#[stable(feature = "pointer_methods", since = "1.26.0")]
#[inline]
pub unsafe fn read_unaligned(self) -> T
where T: Sized,
{
read_unaligned(self)
}

@kennytm kennytm deleted the fix-unaligned-docs branch January 9, 2019 15:06
@RalfJung
Copy link
Member

RalfJung commented Jan 9, 2019

oops sorry for the noise, I forgot that we removed some of these duplicates, including the ones here. And I looked at the wrong version of the docs. :(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants