Update `ptr` docs with regards to `ptr::addr_of!` #83553

jfrimmel · 2021-03-27T10:58:05Z

This updates the documentation since ptr::addr_of! and ptr::addr_of_mut! are now stable. One might remove the distinction between the sections # On packed structs and # Examples, as the old section on packed structs was primarily to prevent users of doing undefined behavior, which is not necessary anymore.

Technically there is now wrong/outdated documentation on stable, but I don't think this is worth a point release 😉

Fixes #83509.

@rustbot modify labels: T-doc

rust-highfive · 2021-03-27T10:58:07Z

r? @Mark-Simulacrum

(rust-highfive has picked a reviewer for you, use r? to override)

voidc · 2021-03-27T11:28:17Z

ptr::addr_of! should probably also be mentioned here

m-ou-se

Thanks! I have a few small comments:

library/core/src/ptr/mod.rs

bors · 2021-03-27T22:51:08Z

☔ The latest upstream changes (presumably #83580) made this pull request unmergeable. Please resolve the merge conflicts.

jfrimmel · 2021-03-28T09:35:54Z

ptr::addr_of! should probably also be mentioned here

Included in the latest commit.

Rebased to resolve merge conflicts.

library/core/src/ptr/mod.rs

library/std/src/primitive_docs.rs

library/core/src/ptr/mod.rs

Soveu · 2021-04-21T10:54:01Z

@jfrimmel a gentle reminder, that we are waiting for you 😅

jyn514 · 2021-04-23T12:46:37Z

@jfrimmel fyi you can change the labels with @rustbot modify labels +S-waiting-on-review -S-waiting-on-author. I'd suggest doing that whenever this is ready for review, otherwise things have a tendency to fall through the cracks until the triage team looks at them.

jfrimmel · 2021-04-23T13:40:22Z

Thank you for the information!

library/core/src/ptr/mod.rs

library/std/src/primitive_docs.rs

jfrimmel · 2021-04-24T11:27:59Z

I've applied the latest review. This PR contains now 6 commits, should I squash them (but I don't know whether GitHub supports multiple Co-authored-by:-lines)?

m-ou-se · 2021-04-24T16:33:51Z

library/std/src/primitive_docs.rs

+/// Those macros have an advantage over the coercion: you can create raw
+/// pointers to unaligned fields, which might be necessary if packed structs
+/// are involved.


This makes it sound like unaligned fields are the only reason to use addr_of instead of coercing from a reference. But making pointers to e.g. uninitialized data is another important use case.

m-ou-se · 2021-04-24T16:34:35Z

Feel free to squash the commits.

Update `ptr` docs with regards to `ptr::addr_of!` This updates the documentation since `ptr::addr_of!` and `ptr::addr_of_mut!` are now stable. One might remove the distinction between the sections `# On packed structs` and `# Examples`, as the old section on packed structs was primarily to prevent users of doing undefined behavior, which is not necessary anymore. Technically there is now wrong/outdated documentation on stable, but I don't think this is worth a point release 😉 Fixes rust-lang#83509. `@rustbot` modify labels: T-doc

Update `ptr` docs with regards to `ptr::addr_of!` This updates the documentation since `ptr::addr_of!` and `ptr::addr_of_mut!` are now stable. One might remove the distinction between the sections `# On packed structs` and `# Examples`, as the old section on packed structs was primarily to prevent users of doing undefined behavior, which is not necessary anymore. Technically there is now wrong/outdated documentation on stable, but I don't think this is worth a point release 😉 Fixes rust-lang#83509. ``@rustbot`` modify labels: T-doc

Update `ptr` docs with regards to `ptr::addr_of!` This updates the documentation since `ptr::addr_of!` and `ptr::addr_of_mut!` are now stable. One might remove the distinction between the sections `# On packed structs` and `# Examples`, as the old section on packed structs was primarily to prevent users of doing undefined behavior, which is not necessary anymore. Technically there is now wrong/outdated documentation on stable, but I don't think this is worth a point release 😉 Fixes rust-lang#83509. ```@rustbot``` modify labels: T-doc

Update `ptr` docs with regards to `ptr::addr_of!` This updates the documentation since `ptr::addr_of!` and `ptr::addr_of_mut!` are now stable. One might remove the distinction between the sections `# On packed structs` and `# Examples`, as the old section on packed structs was primarily to prevent users of doing undefined behavior, which is not necessary anymore. Technically there is now wrong/outdated documentation on stable, but I don't think this is worth a point release 😉 Fixes rust-lang#83509. ````@rustbot```` modify labels: T-doc

Update `ptr` docs with regards to `ptr::addr_of!` This updates the documentation since `ptr::addr_of!` and `ptr::addr_of_mut!` are now stable. One might remove the distinction between the sections `# On packed structs` and `# Examples`, as the old section on packed structs was primarily to prevent users of doing undefined behavior, which is not necessary anymore. Technically there is now wrong/outdated documentation on stable, but I don't think this is worth a point release 😉 Fixes rust-lang#83509. `````@rustbot````` modify labels: T-doc

Update `ptr` docs with regards to `ptr::addr_of!` This updates the documentation since `ptr::addr_of!` and `ptr::addr_of_mut!` are now stable. One might remove the distinction between the sections `# On packed structs` and `# Examples`, as the old section on packed structs was primarily to prevent users of doing undefined behavior, which is not necessary anymore. Technically there is now wrong/outdated documentation on stable, but I don't think this is worth a point release 😉 Fixes rust-lang#83509. ``````@rustbot`````` modify labels: T-doc

Update `ptr` docs with regards to `ptr::addr_of!` This updates the documentation since `ptr::addr_of!` and `ptr::addr_of_mut!` are now stable. One might remove the distinction between the sections `# On packed structs` and `# Examples`, as the old section on packed structs was primarily to prevent users of doing undefined behavior, which is not necessary anymore. Technically there is now wrong/outdated documentation on stable, but I don't think this is worth a point release 😉 Fixes rust-lang#83509. ```````@rustbot``````` modify labels: T-doc

Update `ptr` docs with regards to `ptr::addr_of!` This updates the documentation since `ptr::addr_of!` and `ptr::addr_of_mut!` are now stable. One might remove the distinction between the sections `# On packed structs` and `# Examples`, as the old section on packed structs was primarily to prevent users of doing undefined behavior, which is not necessary anymore. Technically there is now wrong/outdated documentation on stable, but I don't think this is worth a point release 😉 Fixes rust-lang#83509. ````````@rustbot```````` modify labels: T-doc

Update `ptr` docs with regards to `ptr::addr_of!` This updates the documentation since `ptr::addr_of!` and `ptr::addr_of_mut!` are now stable. One might remove the distinction between the sections `# On packed structs` and `# Examples`, as the old section on packed structs was primarily to prevent users of doing undefined behavior, which is not necessary anymore. Technically there is now wrong/outdated documentation on stable, but I don't think this is worth a point release 😉 Fixes rust-lang#83509. `````````@rustbot````````` modify labels: T-doc

Rollup of 11 pull requests Successful merges: - rust-lang#83553 (Update `ptr` docs with regards to `ptr::addr_of!`) - rust-lang#84183 (Update RELEASES.md for 1.52.0) - rust-lang#84709 (Add doc alias for `chdir` to `std::env::set_current_dir`) - rust-lang#84803 (Reduce duplication in `impl_dep_tracking_hash` macros) - rust-lang#84808 (Account for unsatisfied bounds in E0599) - rust-lang#84843 (use else if in std library ) - rust-lang#84865 (rustbuild: Pass a `threads` flag that works to windows-gnu lld) - rust-lang#84878 (Clarify documentation for `[T]::contains`) - rust-lang#84882 (platform-support: Center the contents of the `std` and `host` columns) - rust-lang#84903 (Remove `rustc_middle::mir::interpret::CheckInAllocMsg::NullPointerTest`) - rust-lang#84913 (Do not ICE on invalid const param) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rust-highfive assigned Mark-Simulacrum Mar 27, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 27, 2021

rustbot added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Mar 27, 2021

m-ou-se reviewed Mar 27, 2021

View reviewed changes

library/core/src/ptr/mod.rs Outdated Show resolved Hide resolved

library/core/src/ptr/mod.rs Outdated Show resolved Hide resolved

library/core/src/ptr/mod.rs Outdated Show resolved Hide resolved

m-ou-se assigned m-ou-se and unassigned Mark-Simulacrum Mar 27, 2021

the8472 reviewed Mar 27, 2021

View reviewed changes

library/core/src/ptr/mod.rs Outdated Show resolved Hide resolved

jfrimmel force-pushed the addr-of branch from 41da236 to fc69c8a Compare March 28, 2021 09:33

This comment has been minimized.

Sign in to view

jfrimmel force-pushed the addr-of branch 2 times, most recently from 177a65e to 95ea4c1 Compare March 28, 2021 10:44

jyn514 reviewed Apr 10, 2021

View reviewed changes

library/core/src/ptr/mod.rs Outdated Show resolved Hide resolved

library/core/src/ptr/mod.rs Outdated Show resolved Hide resolved

library/std/src/primitive_docs.rs Outdated Show resolved Hide resolved

RalfJung reviewed Apr 10, 2021

View reviewed changes

library/core/src/ptr/mod.rs Outdated Show resolved Hide resolved

m-ou-se added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 14, 2021

Soveu reviewed Apr 17, 2021

View reviewed changes

library/core/src/ptr/mod.rs Outdated Show resolved Hide resolved

jyn514 added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Apr 23, 2021

RalfJung reviewed Apr 23, 2021

View reviewed changes

library/core/src/ptr/mod.rs Outdated Show resolved Hide resolved

RalfJung reviewed Apr 23, 2021

View reviewed changes

library/std/src/primitive_docs.rs Outdated Show resolved Hide resolved

m-ou-se reviewed Apr 24, 2021

View reviewed changes

Dylan-DPC-zz mentioned this pull request May 4, 2021

Rollup of 11 pull requests #84899

Closed

Dylan-DPC-zz mentioned this pull request May 4, 2021

Rollup of 11 pull requests #84907

Closed

Dylan-DPC-zz mentioned this pull request May 4, 2021

Rollup of 12 pull requests #84912

Closed

Dylan-DPC-zz mentioned this pull request May 4, 2021

Rollup of 12 pull requests #84924

Closed

Dylan-DPC-zz mentioned this pull request May 4, 2021

Rollup of 15 pull requests #84928

Closed

Dylan-DPC-zz mentioned this pull request May 4, 2021

Rollup of 15 pull requests #84932

Closed

RalfJung mentioned this pull request May 5, 2021

Rollup of 13 pull requests #84947

Closed

RalfJung mentioned this pull request May 5, 2021

Rollup of 11 pull requests #84948

Closed

Dylan-DPC-zz mentioned this pull request May 5, 2021

Rollup of 11 pull requests #84951

Closed

RalfJung mentioned this pull request May 5, 2021

Rollup of 11 pull requests #84956

Merged

bors merged commit 722bebf into rust-lang:master May 5, 2021

rustbot added this to the 1.54.0 milestone May 5, 2021

jfrimmel deleted the addr-of branch October 14, 2021 14:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update `ptr` docs with regards to `ptr::addr_of!` #83553

Update `ptr` docs with regards to `ptr::addr_of!` #83553

jfrimmel commented Mar 27, 2021 •

edited

Loading

rust-highfive commented Mar 27, 2021

voidc commented Mar 27, 2021

m-ou-se left a comment

bors commented Mar 27, 2021

jfrimmel commented Mar 28, 2021

This comment has been minimized.

Soveu commented Apr 21, 2021

jyn514 commented Apr 23, 2021

jfrimmel commented Apr 23, 2021

jfrimmel commented Apr 24, 2021

m-ou-se Apr 24, 2021

m-ou-se commented Apr 24, 2021

Update ptr docs with regards to ptr::addr_of! #83553

Update ptr docs with regards to ptr::addr_of! #83553

Conversation

jfrimmel commented Mar 27, 2021 • edited Loading

rust-highfive commented Mar 27, 2021

voidc commented Mar 27, 2021

m-ou-se left a comment

Choose a reason for hiding this comment

bors commented Mar 27, 2021

jfrimmel commented Mar 28, 2021

This comment has been minimized.

Soveu commented Apr 21, 2021

jyn514 commented Apr 23, 2021

jfrimmel commented Apr 23, 2021

jfrimmel commented Apr 24, 2021

m-ou-se Apr 24, 2021

Choose a reason for hiding this comment

m-ou-se commented Apr 24, 2021

Update `ptr` docs with regards to `ptr::addr_of!` #83553

Update `ptr` docs with regards to `ptr::addr_of!` #83553

jfrimmel commented Mar 27, 2021 •

edited

Loading