Skip to content

Clarify vec docs on deallocation (fixes #46879) - #46884

Merged
bors merged 1 commit into
rust-lang:masterfrom
Manishearth:vec-docs
Dec 22, 2017
Merged

Clarify vec docs on deallocation (fixes #46879)#46884
bors merged 1 commit into
rust-lang:masterfrom
Manishearth:vec-docs

Conversation

@Manishearth

@ManishearthManishearth commented Dec 20, 2017

Copy link
Copy Markdown
Member

@ManishearthManishearth mentioned this pull request Dec 20, 2017
Closed
@kennytmkennytm added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 20, 2017
kjeremy
kjeremy reviewed Dec 20, 2017
View reviewed changes
Comment threadsrc/liballoc/vec.rs
/// details are very subtle — if you intend to allocate memory using a `Vec`
/// and use it for something else (either to pass to unsafe code, or to build your
/// own memory-backed collection), be sure to deallocate this memory by using
/// `from_raw_parts` to recover the `Vec` and then dropping it.

@kjeremykjeremyDec 20, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

As a newb this is confusing. Maybe an explicit inline example would be good.

@ManishearthManishearthDec 21, 2017

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I think that might derail the docs; this is about the usage of vec in unsafe contexts and we don't want to go too deep in the weeds there.

(also, this paragraph is related to advanced usage of rust anyway)

@tinaun

tinaun commented Dec 21, 2017

Copy link
Copy Markdown
Contributor

“to recover the Vec and then dropping it” sounds weird but I don’t know if “drop it” is grammatically correct either

@steveklabnik

steveklabnik commented Dec 21, 2017

Copy link
Copy Markdown
Contributor

@bors: r+ rollup

@tinaun it doesn't sound odd to me; we might be able to simplify it by splitting the sentences up a bit, but this is good enough to fix the bug, imo.

@bors

bors commented Dec 21, 2017

Copy link
Copy Markdown
Collaborator

📌 Commit 52c28ff has been approved by steveklabnik

@Manishearth

Manishearth commented Dec 21, 2017 via email

Copy link
Copy Markdown
MemberAuthor

kennytm added a commit to kennytm/rust that referenced this pull request Dec 21, 2017
@kennytm
Rollup merge ofrust-lang#46884- Manishearth:vec-docs, r=steveklabnik
7767d84
Clarify vec docs on deallocation (fixesrust-lang#46879)
r? @steveklabnik
@kennytmkennytm mentioned this pull request Dec 21, 2017
Merged
bors added a commit that referenced this pull request Dec 21, 2017
@bors
Auto merge of#46922- kennytm:rollup, r=kennytm
ba27415
Rollup of 14 pull requests
- Successful merges: #46636, #46780, #46784, #46809, #46814, #46820, #46839, #46847, #46858, #46878, #46884, #46890, #46898, #46918
- Failed merges:
@bors
bors merged commit 52c28ff into rust-lang:masterDec 22, 2017
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers
@kjeremykjeremykjeremy left review comments
@steveklabniksteveklabniksteveklabnik approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@steveklabniksteveklabnik

Labels

S-waiting-on-reviewStatus: Awaiting review from the assignee but also interested parties.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Manishearth@tinaun@steveklabnik@bors@kjeremy@kennytm