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

Better document Box and alloc::alloc::box_free connection #90723

Merged
merged 1 commit into from
Nov 9, 2021

Conversation

asquared31415
Copy link
Contributor

The internal alloc::alloc::box_free function requires that its signature matches the owned_box struct's declaration, but previously that connection was only documented on the box_free function.

This PR makes the documentation two-way to help anyone making theoretical changes to Box to see the connection, since changes are more likely to originate from Box.

@rust-highfive
Copy link
Collaborator

r? @kennytm

(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 Nov 9, 2021
@jyn514
Copy link
Member

jyn514 commented Nov 9, 2021

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Nov 9, 2021

📌 Commit db4e60b has been approved by jyn514

@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 Nov 9, 2021
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Nov 9, 2021
Better document `Box` and `alloc::alloc::box_free` connection

The internal `alloc::alloc::box_free` function requires that its signature matches the `owned_box` struct's declaration, but previously that connection was only documented on the `box_free` function.

This PR makes the documentation two-way to help anyone making theoretical changes to `Box` to see the connection, since changes are more likely to originate from `Box`.
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 9, 2021
…askrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#89561 (Type inference for inline consts)
 - rust-lang#90035 (implement rfc-2528 type_changing-struct-update)
 - rust-lang#90613 (Allow to run a specific rustdoc-js* test)
 - rust-lang#90683 (Make `compiler-docs` only control the default instead of being a hard off-switch)
 - rust-lang#90685 (x.py: remove fixme by deleting code)
 - rust-lang#90701 (Record more artifact sizes during self-profiling.)
 - rust-lang#90723 (Better document `Box` and `alloc::alloc::box_free` connection)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 9c1aa12 into rust-lang:master Nov 9, 2021
@rustbot rustbot added this to the 1.58.0 milestone Nov 9, 2021
@asquared31415 asquared31415 deleted the box_docs branch November 10, 2021 09:49
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.

6 participants