Skip to content

Docs reference local and exchange heap without explanation #6882

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

Closed
ghost opened this issue Jun 1, 2013 · 3 comments · Fixed by #10354
Closed

Docs reference local and exchange heap without explanation #6882

ghost opened this issue Jun 1, 2013 · 3 comments · Fixed by #10354
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@ghost
Copy link

ghost commented Jun 1, 2013

In section 13 of the 0.6 docs the local and exchange heap are referenced without previous explanation.

Like other types in Rust, vectors can be stored on the stack, the local heap, or the exchange heap.

@thestinger
Copy link
Contributor

Thanks, the tutorial shouldn't be mentioning exchange/local heap at all because it's easier to just say Owned things are sendable. It's not actually accurate that unique pointers/vectors are allocated on the exchange heap, since that's only true if they don't contain managed pointers.

It might make sense to talk about this in the language reference but... it would make even more sense to treat it as an implementation detail, covered in a separate implementation document.

@catamorphism
Copy link
Contributor

The main tutorial, tasks tutorial, and borrowed pointer tutorial still mention the exchange heap. Easy cleanup task.

@graydon
Copy link
Contributor

graydon commented Aug 14, 2013

Runtime is referring to these as local and global heaps now.

bors added a commit that referenced this issue Nov 8, 2013
This section desperately needs to be expanded, but removing the
misleading/incorrect information is a priority.

Managed vectors/strings are not covered, as they are feature-gated and
are only a micro-optimization to avoid double-indirection.

Closes #6882
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants