Skip to content

mention provenance in the pointer::wrapping_offset docs - #139192

Merged
bors merged 1 commit into
rust-lang:masterfrom
lolbinarycat:docs-wrapping_offset-provenance-139008
Apr 30, 2025
Merged

mention provenance in the pointer::wrapping_offset docs#139192
bors merged 1 commit into
rust-lang:masterfrom
lolbinarycat:docs-wrapping_offset-provenance-139008

Conversation

@lolbinarycat

@lolbinarycatlolbinarycat commented Mar 31, 2025

Copy link
Copy Markdown
Contributor

fixes#139008

@rustbot

rustbot commented Mar 31, 2025

Copy link
Copy Markdown
Collaborator

r? @workingjubilee

rustbot has assigned @workingjubilee.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbotrustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Mar 31, 2025
workingjubilee
workingjubilee reviewed Mar 31, 2025
View reviewed changes
Comment threadlibrary/core/src/ptr/const_ptr.rs Outdated
/// This operation itself is always safe, but using the resulting pointer is not.
///
/// The resulting pointer "remembers" the [allocated object] that `self` points to; it must not
/// The resulting pointer "remembers"[^1] the [allocated object] that `self` points to; it must not

@workingjubileeworkingjubileeMar 31, 2025•
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we just say

Suggested change
/// The resulting pointer "remembers"[^1] the [allocated object] that `self` points to; it must not
/// The resulting pointer has the provenance of the [allocated object] that `self` points to; it must not

@workingjubileeworkingjubileeMar 31, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idk, does that flow correctly?

@lolbinarycatlolbinarycatMar 31, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation for provenance actually quotes the current phrasing:

As another example, consider that wrapping_offset is documented to “remember” the allocated object that the original pointer points to, even if it is offset far outside the memory range occupied by that allocated object.

If we change the phrasing of the wrapping_offset docs, this example will become circular and awkward, so I think it's best to leave it as-is.

@workingjubileeworkingjubileeApr 29, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see.

@tgross35

tgross35 commented Apr 27, 2025

Copy link
Copy Markdown
Member

Cc @RalfJung, your kind of docs :)

RalfJung
RalfJung reviewed Apr 27, 2025
View reviewed changes
Comment threadlibrary/core/src/ptr/const_ptr.rs Outdated
@RalfJung

RalfJung commented Apr 29, 2025

Copy link
Copy Markdown
Member

I don't see the suggestion applied?
@rustbot author

@rustbotrustbot 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 29, 2025
@rustbot

rustbot commented Apr 29, 2025

Copy link
Copy Markdown
Collaborator

Reminder, once the PR becomes ready for a review, use @rustbot ready.

@lolbinarycat

lolbinarycat commented Apr 29, 2025

Copy link
Copy Markdown
ContributorAuthor

@RalfJung oops, forgot to push.

@rustbot ready

@rustbotrustbot 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 29, 2025
RalfJung
RalfJung reviewed Apr 29, 2025
View reviewed changes
Comment threadlibrary/core/src/ptr/const_ptr.rs Outdated
@lolbinarycat
lolbinarycatforce-pushed the docs-wrapping_offset-provenance-139008 branch from 249fa89 to 851decdCompareApril 29, 2025 19:29
@RalfJung

RalfJung commented Apr 29, 2025

Copy link
Copy Markdown
Member

Thanks!

@bors r+ rollup

@bors

bors commented Apr 29, 2025

Copy link
Copy Markdown
Collaborator

📌 Commit 851decd has been approved by RalfJung

It is now in the queue for this repository.

@borsbors 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 Apr 29, 2025
ChrisDenton added a commit to ChrisDenton/rust that referenced this pull request Apr 30, 2025
@ChrisDenton
Rollup merge ofrust-lang#139192- lolbinarycat:docs-wrapping_offset-…
5316bd8
…provenance-139008, r=RalfJung
mention provenance in the pointer::wrapping_offset docs
fixesrust-lang#139008
@ChrisDentonChrisDenton mentioned this pull request Apr 30, 2025
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Apr 30, 2025
@bors
Auto merge ofrust-lang#140495- ChrisDenton:rollup-wqm2yat, r=ChrisD…
0b7df37
…enton
Rollup of 9 pull requests
Successful merges:
- rust-lang#139192 (mention provenance in the pointer::wrapping_offset docs)
- rust-lang#140176 (Fix linking statics on Arm64EC)
- rust-lang#140404 (rm `TypeVistable` impls for `Canonical`)
- rust-lang#140437 (enable msa feature for mips in codegen tests)
- rust-lang#140438 (Add `rust.debug-assertions-tools` option)
- rust-lang#140446 (chore: fix some tests)
- rust-lang#140470 (CI: rfl: move job forward to Linux v6.15-rc4)
- rust-lang#140476 (chore: delete unused ui/auxiliary crates)
- rust-lang#140481 (Require sanitizers be enabled for asan_odr_windows.rs)
r? `@ghost`
`@rustbot` modify labels: rollup
Zalathar added a commit to Zalathar/rust that referenced this pull request Apr 30, 2025
@Zalathar
Rollup merge ofrust-lang#139192- lolbinarycat:docs-wrapping_offset-…
4ad2470
…provenance-139008, r=RalfJung
mention provenance in the pointer::wrapping_offset docs
fixesrust-lang#139008
@ZalatharZalathar mentioned this pull request Apr 30, 2025
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Apr 30, 2025
@bors
Auto merge ofrust-lang#140499- Zalathar:rollup-8qpbuw0, r=Zalathar
c9d3ed8
Rollup of 12 pull requests
Successful merges:
- rust-lang#136160 (Remove backticks from `ShouldPanic::YesWithMessage`'s `TrFailedMsg`)
- rust-lang#138087 (Initial implementation of `core_float_math`)
- rust-lang#139059 (uses_power_alignment: wording tweaks)
- rust-lang#139192 (mention provenance in the pointer::wrapping_offset docs)
- rust-lang#140312 (Improve pretty-printing of braces)
- rust-lang#140404 (rm `TypeVistable` impls for `Canonical`)
- rust-lang#140437 (enable msa feature for mips in codegen tests)
- rust-lang#140438 (Add `rust.debug-assertions-tools` option)
- rust-lang#140439 (miri: algebraic intrinsics: bring back float non-determinism)
- rust-lang#140445 (Treat ManuallyDrop as ~const Destruct)
- rust-lang#140446 (chore: fix some tests)
- rust-lang#140448 (Rename `rustc_query_append!` to `rustc_with_all_queries!`)
Failed merges:
- rust-lang#140456 (Fix test simd/extract-insert-dyn on s390x)
r? `@ghost`
`@rustbot` modify labels: rollup
@matthiaskrgrmatthiaskrgr mentioned this pull request Apr 30, 2025
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Apr 30, 2025
@bors
Auto merge ofrust-lang#140503- matthiaskrgr:rollup-n7zigts, r=matth…
7188f45
…iaskrgr
Rollup of 11 pull requests
Successful merges:
- rust-lang#136160 (Remove backticks from `ShouldPanic::YesWithMessage`'s `TrFailedMsg`)
- rust-lang#139059 (uses_power_alignment: wording tweaks)
- rust-lang#139192 (mention provenance in the pointer::wrapping_offset docs)
- rust-lang#140312 (Improve pretty-printing of braces)
- rust-lang#140404 (rm `TypeVistable` impls for `Canonical`)
- rust-lang#140437 (enable msa feature for mips in codegen tests)
- rust-lang#140438 (Add `rust.debug-assertions-tools` option)
- rust-lang#140439 (miri: algebraic intrinsics: bring back float non-determinism)
- rust-lang#140445 (Treat ManuallyDrop as ~const Destruct)
- rust-lang#140446 (chore: fix some tests)
- rust-lang#140448 (Rename `rustc_query_append!` to `rustc_with_all_queries!`)
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit aeec053 into rust-lang:masterApr 30, 2025
@rustbotrustbot added this to the 1.88.0 milestone Apr 30, 2025
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Apr 30, 2025
@rust-timer
Unrolled build forrust-lang#139192
dce67d5
Rollup merge of rust-lang#139192 - lolbinarycat:docs-wrapping_offset-provenance-139008, r=RalfJung
mention provenance in the pointer::wrapping_offset docs
fixesrust-lang#139008
github-actionsBot pushed a commit to model-checking/verify-rust-std that referenced this pull request May 9, 2025
@matthiaskrgr
Rollup merge ofrust-lang#139192- lolbinarycat:docs-wrapping_offset-…
e3e899b
…provenance-139008, r=RalfJung
mention provenance in the pointer::wrapping_offset docs
fixesrust-lang#139008
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@RalfJungRalfJungRalfJung left review comments
@tgross35tgross35tgross35 left review comments
@workingjubileeworkingjubileeworkingjubilee left review comments

Assignees

@workingjubileeworkingjubilee

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-libsRelevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.88.0

Development

Successfully merging this pull request may close these issues.

pointer::wrapping_offset should mention provenance

6 participants

@lolbinarycat@rustbot@tgross35@RalfJung@bors@workingjubilee