-
Notifications
You must be signed in to change notification settings - Fork 13.5k
Rename TARPL to the Rustonomicon #27444
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
% The Rustonomicon | ||
|
||
#### The Dark Arts of Advanced and Unsafe Rust Programming | ||
|
||
# NOTE: This is a draft document, and may contain serious errors | ||
|
||
> Instead of the programs I had hoped for, there came only a shuddering blackness | ||
and ineffable loneliness; and I saw at last a fearful truth which no one had | ||
ever dared to breathe before — the unwhisperable secret of secrets — The fact | ||
that this language of stone and stridor is not a sentient perpetuation of Rust | ||
as London is of Old London and Paris of Old Paris, but that it is in fact | ||
quite unsafe, its sprawling body imperfectly embalmed and infested with queer | ||
animate things which have nothing to do with it as it was in compilation. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is hilarious. |
||
|
||
This book digs into all the awful details that are necessary to understand in | ||
order to write correct Unsafe Rust programs. Due to the nature of this problem, | ||
it may lead to unleashing untold horrors that shatter your psyche into a billion | ||
infinitesimal fragments of despair. | ||
|
||
Should you wish a long and happy career of writing Rust programs, you should | ||
turn back now and forget you ever saw this book. It is not necessary. However | ||
if you intend to write unsafe code -- or just want to dig into the guts of the | ||
language -- this book contains invaluable information. | ||
|
||
Unlike [The Book][trpl] we will be assuming considerable prior knowledge. In | ||
particular, you should be comfortable with basic systems programming and Rust. | ||
If you don't feel comfortable with these topics, you should consider [reading | ||
The Book][trpl] first. Though we will not be assuming that you have, and will | ||
take care to occasionally give a refresher on the basics where appropriate. You | ||
can skip straight to this book if you want; just know that we won't be | ||
explaining everything from the ground up. | ||
|
||
To be clear, this book goes into deep detail. We're going to dig into | ||
exception-safety, pointer aliasing, memory models, and even some type-theory. | ||
We will also be spending a lot of time talking about the different kinds | ||
of safety and guarantees. | ||
|
||
[trpl]: ../book/ |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This translates to the ultimate URL of the doc and I wonder if 'doc/rustonomicon' would be clearer, more guessable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes -- I personally felt
rustonomicon
was a bit too long, and also expect people to mess up the vowel afterrust
. I also don't expect much cold-typing of the URL. just autocompleteing/linking/bookmark/search.