Fix up documentation around no_std #34838
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I wonder if we can also make sure these is all plastered with "zomg this is unstable"? Documenting things like symbol names makes me a little queasy as I don't want anyone relying on that ever basically |
| # #[no_mangle] pub extern fn rust_eh_register_frames () {} | ||
| # #[no_mangle] pub extern fn rust_eh_unregister_frames () {} | ||
| # // fn main() {} tricked you, rustdoc! | ||
| // These functions and traits are used by the compiler, but not |
There was a problem hiding this comment.
Whoops, this was just the previous text.
So, the book part is explicitly in "unstable rust", but making it more clear in libcore's docs is something I can do! |
|
Ok! Sounds good to me, looks like travis failure is legit though: r=me other than that though |
1. Fix the sections in the book to have the correct signatures. I've also marked them as `ignore`; there's no way to set the `no_std` feature for libc, so it pulls in the stdlib, so this wasn't even testing the actual thing it was testing. Better to just ignore. 2. Correcting libcore's docs for factual inaccuracy, and add a note about language items. Fixes rust-lang#33677
|
Whoops, I was checking as I wrote it, but missed it in the end. Should be good now, let's see what travis says. |
|
@bors: rollup |
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Jul 16, 2016
Fix up documentation around no_std 1. Fix the sections in the book to have the correct signatures. I've also marked them as `ignore`; there's no way to set the `no_std` feature for libc, so it pulls in the stdlib, so this wasn't even testing the actual thing it was testing. Better to just ignore. 2. Correcting libcore's docs for factual inaccuracy, and add a note about language items. Fixes rust-lang#33677 r? @alexcrichton
bors
added a commit
that referenced
this pull request
Jul 17, 2016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
also marked them as
ignore; there's no way to set theno_stdfeature for libc, so it pulls in the stdlib, so this wasn't even
testing the actual thing it was testing. Better to just ignore.
about language items.
Fixes #33677
r? @alexcrichton