mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-26 00:34:06 +00:00
rename TARPL to The Rustinomicon
This commit is contained in:
parent
f7b3cd3337
commit
ca902dd8cb
10
mk/docs.mk
10
mk/docs.mk
@ -77,7 +77,7 @@ ERR_IDX_GEN = $(RPATH_VAR2_T_$(CFG_BUILD)_H_$(CFG_BUILD)) $(ERR_IDX_GEN_EXE)
|
||||
|
||||
D := $(S)src/doc
|
||||
|
||||
DOC_TARGETS := trpl tarpl style error-index
|
||||
DOC_TARGETS := trpl nomicon style error-index
|
||||
COMPILER_DOC_TARGETS :=
|
||||
DOC_L10N_TARGETS :=
|
||||
|
||||
@ -287,12 +287,12 @@ doc/book/index.html: $(RUSTBOOK_EXE) $(wildcard $(S)/src/doc/trpl/*.md) | doc/
|
||||
$(Q)rm -rf doc/book
|
||||
$(Q)$(RUSTBOOK) build $(S)src/doc/trpl doc/book
|
||||
|
||||
tarpl: doc/adv-book/index.html
|
||||
nomicon: doc/nomicon/index.html
|
||||
|
||||
doc/adv-book/index.html: $(RUSTBOOK_EXE) $(wildcard $(S)/src/doc/tarpl/*.md) | doc/
|
||||
doc/nomicon/index.html: $(RUSTBOOK_EXE) $(wildcard $(S)/src/doc/nomicon/*.md) | doc/
|
||||
@$(call E, rustbook: $@)
|
||||
$(Q)rm -rf doc/adv-book
|
||||
$(Q)$(RUSTBOOK) build $(S)src/doc/tarpl doc/adv-book
|
||||
$(Q)rm -rf doc/nomicon
|
||||
$(Q)$(RUSTBOOK) build $(S)src/doc/nomicon doc/nomicon
|
||||
|
||||
style: doc/style/index.html
|
||||
|
||||
|
@ -162,8 +162,8 @@ $(foreach doc,$(DOCS), \
|
||||
$(eval $(call DOCTEST,md-$(doc),$(S)src/doc/$(doc).md)))
|
||||
$(foreach file,$(wildcard $(S)src/doc/trpl/*.md), \
|
||||
$(eval $(call DOCTEST,$(file:$(S)src/doc/trpl/%.md=trpl-%),$(file))))
|
||||
$(foreach file,$(wildcard $(S)src/doc/tarpl/*.md), \
|
||||
$(eval $(call DOCTEST,$(file:$(S)src/doc/tarpl/%.md=tarpl-%),$(file))))
|
||||
$(foreach file,$(wildcard $(S)src/doc/nomicon/*.md), \
|
||||
$(eval $(call DOCTEST,$(file:$(S)src/doc/nomicon/%.md=nomicon-%),$(file))))
|
||||
######################################################################
|
||||
# Main test targets
|
||||
######################################################################
|
||||
|
38
src/doc/nomicon/README.md
Normal file
38
src/doc/nomicon/README.md
Normal file
@ -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.
|
||||
|
||||
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/
|
@ -1,34 +0,0 @@
|
||||
% The Advanced Rust Programming Language
|
||||
|
||||
# NOTE: This is a draft document, and may contain serious errors
|
||||
|
||||
So you've played around with Rust a bit. You've written a few simple programs
|
||||
and you think you grok the basics. Maybe you've even read through *[The Rust
|
||||
Programming Language][trpl]* (TRPL). Now you want to get neck-deep in all the
|
||||
nitty-gritty details of the language. You want to know those weird corner-cases.
|
||||
You want to know what the heck `unsafe` really means, and how to properly use
|
||||
it. This is the book for you.
|
||||
|
||||
To be clear, this book goes into serious detail. We're going to dig into
|
||||
exception-safety and pointer aliasing. We're going to talk about memory
|
||||
models. We're even going to do some type-theory. This is stuff that you
|
||||
absolutely don't need to know to write fast and safe Rust programs.
|
||||
You could probably close this book *right now* and still have a productive
|
||||
and happy career in Rust.
|
||||
|
||||
However if you intend to write unsafe code -- or just really want to dig into
|
||||
the guts of the language -- this book contains invaluable information.
|
||||
|
||||
Unlike TRPL we will be assuming considerable prior knowledge. In particular, you
|
||||
should be comfortable with basic systems programming and basic Rust. If you
|
||||
don't feel comfortable with these topics, you should consider [reading
|
||||
TRPL][trpl], though we will not be assuming that you have. You can skip
|
||||
straight to this book if you want; just know that we won't be explaining
|
||||
everything from the ground up.
|
||||
|
||||
Due to the nature of advanced Rust programming, we will be spending a lot of
|
||||
time talking about *safety* and *guarantees*. In particular, a significant
|
||||
portion of the book will be dedicated to correctly writing and understanding
|
||||
Unsafe Rust.
|
||||
|
||||
[trpl]: ../book/
|
Loading…
Reference in New Issue
Block a user