diff options
| -rw-r--r-- | mk/docs.mk | 10 | ||||
| -rw-r--r-- | mk/tests.mk | 4 | ||||
| -rw-r--r-- | src/doc/nomicon/README.md | 38 | ||||
| -rw-r--r-- | src/doc/nomicon/SUMMARY.md (renamed from src/doc/tarpl/SUMMARY.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/arc-and-mutex.md (renamed from src/doc/tarpl/arc-and-mutex.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/atomics.md (renamed from src/doc/tarpl/atomics.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/borrow-splitting.md (renamed from src/doc/tarpl/borrow-splitting.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/casts.md (renamed from src/doc/tarpl/casts.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/checked-uninit.md (renamed from src/doc/tarpl/checked-uninit.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/coercions.md (renamed from src/doc/tarpl/coercions.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/concurrency.md (renamed from src/doc/tarpl/concurrency.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/constructors.md (renamed from src/doc/tarpl/constructors.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/conversions.md (renamed from src/doc/tarpl/conversions.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/data.md (renamed from src/doc/tarpl/data.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/destructors.md (renamed from src/doc/tarpl/destructors.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/dot-operator.md (renamed from src/doc/tarpl/dot-operator.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/drop-flags.md (renamed from src/doc/tarpl/drop-flags.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/dropck.md (renamed from src/doc/tarpl/dropck.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/exception-safety.md (renamed from src/doc/tarpl/exception-safety.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/exotic-sizes.md (renamed from src/doc/tarpl/exotic-sizes.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/hrtb.md (renamed from src/doc/tarpl/hrtb.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/leaking.md (renamed from src/doc/tarpl/leaking.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/lifetime-elision.md (renamed from src/doc/tarpl/lifetime-elision.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/lifetime-mismatch.md (renamed from src/doc/tarpl/lifetime-mismatch.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/lifetimes.md (renamed from src/doc/tarpl/lifetimes.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/meet-safe-and-unsafe.md (renamed from src/doc/tarpl/meet-safe-and-unsafe.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/obrm.md (renamed from src/doc/tarpl/obrm.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/other-reprs.md (renamed from src/doc/tarpl/other-reprs.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/ownership.md (renamed from src/doc/tarpl/ownership.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/phantom-data.md (renamed from src/doc/tarpl/phantom-data.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/poisoning.md (renamed from src/doc/tarpl/poisoning.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/races.md (renamed from src/doc/tarpl/races.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/references.md (renamed from src/doc/tarpl/references.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/repr-rust.md (renamed from src/doc/tarpl/repr-rust.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/safe-unsafe-meaning.md (renamed from src/doc/tarpl/safe-unsafe-meaning.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/send-and-sync.md (renamed from src/doc/tarpl/send-and-sync.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/subtyping.md (renamed from src/doc/tarpl/subtyping.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/transmutes.md (renamed from src/doc/tarpl/transmutes.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/unbounded-lifetimes.md (renamed from src/doc/tarpl/unbounded-lifetimes.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/unchecked-uninit.md (renamed from src/doc/tarpl/unchecked-uninit.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/uninitialized.md (renamed from src/doc/tarpl/uninitialized.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/unwinding.md (renamed from src/doc/tarpl/unwinding.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/vec-alloc.md (renamed from src/doc/tarpl/vec-alloc.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/vec-dealloc.md (renamed from src/doc/tarpl/vec-dealloc.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/vec-deref.md (renamed from src/doc/tarpl/vec-deref.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/vec-drain.md (renamed from src/doc/tarpl/vec-drain.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/vec-final.md (renamed from src/doc/tarpl/vec-final.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/vec-insert-remove.md (renamed from src/doc/tarpl/vec-insert-remove.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/vec-into-iter.md (renamed from src/doc/tarpl/vec-into-iter.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/vec-layout.md (renamed from src/doc/tarpl/vec-layout.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/vec-push-pop.md (renamed from src/doc/tarpl/vec-push-pop.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/vec-raw.md (renamed from src/doc/tarpl/vec-raw.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/vec-zsts.md (renamed from src/doc/tarpl/vec-zsts.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/vec.md (renamed from src/doc/tarpl/vec.md) | 0 | ||||
| -rw-r--r-- | src/doc/nomicon/working-with-unsafe.md (renamed from src/doc/tarpl/working-with-unsafe.md) | 0 | ||||
| -rw-r--r-- | src/doc/tarpl/README.md | 34 |
56 files changed, 45 insertions, 41 deletions
diff --git a/mk/docs.mk b/mk/docs.mk index 3acc3c68b8f..a8ab6d55d7f 100644 --- a/mk/docs.mk +++ b/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 diff --git a/mk/tests.mk b/mk/tests.mk index c0962a1b0e7..9341166beb0 100644 --- a/mk/tests.mk +++ b/mk/tests.mk @@ -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 ###################################################################### diff --git a/src/doc/nomicon/README.md b/src/doc/nomicon/README.md new file mode 100644 index 00000000000..4554652a17a --- /dev/null +++ b/src/doc/nomicon/README.md @@ -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/ diff --git a/src/doc/tarpl/SUMMARY.md b/src/doc/nomicon/SUMMARY.md index 7d4ef9c2514..7d4ef9c2514 100644 --- a/src/doc/tarpl/SUMMARY.md +++ b/src/doc/nomicon/SUMMARY.md diff --git a/src/doc/tarpl/arc-and-mutex.md b/src/doc/nomicon/arc-and-mutex.md index fcafe55e409..fcafe55e409 100644 --- a/src/doc/tarpl/arc-and-mutex.md +++ b/src/doc/nomicon/arc-and-mutex.md diff --git a/src/doc/tarpl/atomics.md b/src/doc/nomicon/atomics.md index 2d567e39f8f..2d567e39f8f 100644 --- a/src/doc/tarpl/atomics.md +++ b/src/doc/nomicon/atomics.md diff --git a/src/doc/tarpl/borrow-splitting.md b/src/doc/nomicon/borrow-splitting.md index cc5bc8a602d..cc5bc8a602d 100644 --- a/src/doc/tarpl/borrow-splitting.md +++ b/src/doc/nomicon/borrow-splitting.md diff --git a/src/doc/tarpl/casts.md b/src/doc/nomicon/casts.md index 5f07709cf45..5f07709cf45 100644 --- a/src/doc/tarpl/casts.md +++ b/src/doc/nomicon/casts.md diff --git a/src/doc/tarpl/checked-uninit.md b/src/doc/nomicon/checked-uninit.md index f7c4482a4ab..f7c4482a4ab 100644 --- a/src/doc/tarpl/checked-uninit.md +++ b/src/doc/nomicon/checked-uninit.md diff --git a/src/doc/tarpl/coercions.md b/src/doc/nomicon/coercions.md index 2e33a6729d1..2e33a6729d1 100644 --- a/src/doc/tarpl/coercions.md +++ b/src/doc/nomicon/coercions.md diff --git a/src/doc/tarpl/concurrency.md b/src/doc/nomicon/concurrency.md index 9dcbecdd5b3..9dcbecdd5b3 100644 --- a/src/doc/tarpl/concurrency.md +++ b/src/doc/nomicon/concurrency.md diff --git a/src/doc/tarpl/constructors.md b/src/doc/nomicon/constructors.md index 97817cd1f90..97817cd1f90 100644 --- a/src/doc/tarpl/constructors.md +++ b/src/doc/nomicon/constructors.md diff --git a/src/doc/tarpl/conversions.md b/src/doc/nomicon/conversions.md index b099a789ec3..b099a789ec3 100644 --- a/src/doc/tarpl/conversions.md +++ b/src/doc/nomicon/conversions.md diff --git a/src/doc/tarpl/data.md b/src/doc/nomicon/data.md index d0a796b7f0b..d0a796b7f0b 100644 --- a/src/doc/tarpl/data.md +++ b/src/doc/nomicon/data.md diff --git a/src/doc/tarpl/destructors.md b/src/doc/nomicon/destructors.md index 568f7c07f59..568f7c07f59 100644 --- a/src/doc/tarpl/destructors.md +++ b/src/doc/nomicon/destructors.md diff --git a/src/doc/tarpl/dot-operator.md b/src/doc/nomicon/dot-operator.md index 5d2010d15a8..5d2010d15a8 100644 --- a/src/doc/tarpl/dot-operator.md +++ b/src/doc/nomicon/dot-operator.md diff --git a/src/doc/tarpl/drop-flags.md b/src/doc/nomicon/drop-flags.md index 1e81c97479b..1e81c97479b 100644 --- a/src/doc/tarpl/drop-flags.md +++ b/src/doc/nomicon/drop-flags.md diff --git a/src/doc/tarpl/dropck.md b/src/doc/nomicon/dropck.md index df09d1a1744..df09d1a1744 100644 --- a/src/doc/tarpl/dropck.md +++ b/src/doc/nomicon/dropck.md diff --git a/src/doc/tarpl/exception-safety.md b/src/doc/nomicon/exception-safety.md index 74f7831a72a..74f7831a72a 100644 --- a/src/doc/tarpl/exception-safety.md +++ b/src/doc/nomicon/exception-safety.md diff --git a/src/doc/tarpl/exotic-sizes.md b/src/doc/nomicon/exotic-sizes.md index 0b653a7ad3a..0b653a7ad3a 100644 --- a/src/doc/tarpl/exotic-sizes.md +++ b/src/doc/nomicon/exotic-sizes.md diff --git a/src/doc/tarpl/hrtb.md b/src/doc/nomicon/hrtb.md index 8692832e2c7..8692832e2c7 100644 --- a/src/doc/tarpl/hrtb.md +++ b/src/doc/nomicon/hrtb.md diff --git a/src/doc/tarpl/leaking.md b/src/doc/nomicon/leaking.md index 1aa78e112ea..1aa78e112ea 100644 --- a/src/doc/tarpl/leaking.md +++ b/src/doc/nomicon/leaking.md diff --git a/src/doc/tarpl/lifetime-elision.md b/src/doc/nomicon/lifetime-elision.md index 41014f46dd9..41014f46dd9 100644 --- a/src/doc/tarpl/lifetime-elision.md +++ b/src/doc/nomicon/lifetime-elision.md diff --git a/src/doc/tarpl/lifetime-mismatch.md b/src/doc/nomicon/lifetime-mismatch.md index 8b01616ee0d..8b01616ee0d 100644 --- a/src/doc/tarpl/lifetime-mismatch.md +++ b/src/doc/nomicon/lifetime-mismatch.md diff --git a/src/doc/tarpl/lifetimes.md b/src/doc/nomicon/lifetimes.md index f211841ec0c..f211841ec0c 100644 --- a/src/doc/tarpl/lifetimes.md +++ b/src/doc/nomicon/lifetimes.md diff --git a/src/doc/tarpl/meet-safe-and-unsafe.md b/src/doc/nomicon/meet-safe-and-unsafe.md index 15e49c747b8..15e49c747b8 100644 --- a/src/doc/tarpl/meet-safe-and-unsafe.md +++ b/src/doc/nomicon/meet-safe-and-unsafe.md diff --git a/src/doc/tarpl/obrm.md b/src/doc/nomicon/obrm.md index 2c495240c12..2c495240c12 100644 --- a/src/doc/tarpl/obrm.md +++ b/src/doc/nomicon/obrm.md diff --git a/src/doc/tarpl/other-reprs.md b/src/doc/nomicon/other-reprs.md index 93ef2c13cdf..93ef2c13cdf 100644 --- a/src/doc/tarpl/other-reprs.md +++ b/src/doc/nomicon/other-reprs.md diff --git a/src/doc/tarpl/ownership.md b/src/doc/nomicon/ownership.md index e80c64c3543..e80c64c3543 100644 --- a/src/doc/tarpl/ownership.md +++ b/src/doc/nomicon/ownership.md diff --git a/src/doc/tarpl/phantom-data.md b/src/doc/nomicon/phantom-data.md index 0d7ec7f1617..0d7ec7f1617 100644 --- a/src/doc/tarpl/phantom-data.md +++ b/src/doc/nomicon/phantom-data.md diff --git a/src/doc/tarpl/poisoning.md b/src/doc/nomicon/poisoning.md index 70de91af61f..70de91af61f 100644 --- a/src/doc/tarpl/poisoning.md +++ b/src/doc/nomicon/poisoning.md diff --git a/src/doc/tarpl/races.md b/src/doc/nomicon/races.md index 3b47502ebfe..3b47502ebfe 100644 --- a/src/doc/tarpl/races.md +++ b/src/doc/nomicon/races.md diff --git a/src/doc/tarpl/references.md b/src/doc/nomicon/references.md index 3d7369eca0f..3d7369eca0f 100644 --- a/src/doc/tarpl/references.md +++ b/src/doc/nomicon/references.md diff --git a/src/doc/tarpl/repr-rust.md b/src/doc/nomicon/repr-rust.md index c8a372be767..c8a372be767 100644 --- a/src/doc/tarpl/repr-rust.md +++ b/src/doc/nomicon/repr-rust.md diff --git a/src/doc/tarpl/safe-unsafe-meaning.md b/src/doc/nomicon/safe-unsafe-meaning.md index 2f15b7050e3..2f15b7050e3 100644 --- a/src/doc/tarpl/safe-unsafe-meaning.md +++ b/src/doc/nomicon/safe-unsafe-meaning.md diff --git a/src/doc/tarpl/send-and-sync.md b/src/doc/nomicon/send-and-sync.md index 334d5c9dd55..334d5c9dd55 100644 --- a/src/doc/tarpl/send-and-sync.md +++ b/src/doc/nomicon/send-and-sync.md diff --git a/src/doc/tarpl/subtyping.md b/src/doc/nomicon/subtyping.md index 3c57297f323..3c57297f323 100644 --- a/src/doc/tarpl/subtyping.md +++ b/src/doc/nomicon/subtyping.md diff --git a/src/doc/tarpl/transmutes.md b/src/doc/nomicon/transmutes.md index f19dda0d8b8..f19dda0d8b8 100644 --- a/src/doc/tarpl/transmutes.md +++ b/src/doc/nomicon/transmutes.md diff --git a/src/doc/tarpl/unbounded-lifetimes.md b/src/doc/nomicon/unbounded-lifetimes.md index b540ab4ed5d..b540ab4ed5d 100644 --- a/src/doc/tarpl/unbounded-lifetimes.md +++ b/src/doc/nomicon/unbounded-lifetimes.md diff --git a/src/doc/tarpl/unchecked-uninit.md b/src/doc/nomicon/unchecked-uninit.md index da9fb294a1e..da9fb294a1e 100644 --- a/src/doc/tarpl/unchecked-uninit.md +++ b/src/doc/nomicon/unchecked-uninit.md diff --git a/src/doc/tarpl/uninitialized.md b/src/doc/nomicon/uninitialized.md index 915ea860291..915ea860291 100644 --- a/src/doc/tarpl/uninitialized.md +++ b/src/doc/nomicon/uninitialized.md diff --git a/src/doc/tarpl/unwinding.md b/src/doc/nomicon/unwinding.md index 3ad95dde39d..3ad95dde39d 100644 --- a/src/doc/tarpl/unwinding.md +++ b/src/doc/nomicon/unwinding.md diff --git a/src/doc/tarpl/vec-alloc.md b/src/doc/nomicon/vec-alloc.md index fc7feba2356..fc7feba2356 100644 --- a/src/doc/tarpl/vec-alloc.md +++ b/src/doc/nomicon/vec-alloc.md diff --git a/src/doc/tarpl/vec-dealloc.md b/src/doc/nomicon/vec-dealloc.md index b767caa4912..b767caa4912 100644 --- a/src/doc/tarpl/vec-dealloc.md +++ b/src/doc/nomicon/vec-dealloc.md diff --git a/src/doc/tarpl/vec-deref.md b/src/doc/nomicon/vec-deref.md index 6460eab479b..6460eab479b 100644 --- a/src/doc/tarpl/vec-deref.md +++ b/src/doc/nomicon/vec-deref.md diff --git a/src/doc/tarpl/vec-drain.md b/src/doc/nomicon/vec-drain.md index 4521bbdd05e..4521bbdd05e 100644 --- a/src/doc/tarpl/vec-drain.md +++ b/src/doc/nomicon/vec-drain.md diff --git a/src/doc/tarpl/vec-final.md b/src/doc/nomicon/vec-final.md index 847957e2ea9..847957e2ea9 100644 --- a/src/doc/tarpl/vec-final.md +++ b/src/doc/nomicon/vec-final.md diff --git a/src/doc/tarpl/vec-insert-remove.md b/src/doc/nomicon/vec-insert-remove.md index 0a37170c52c..0a37170c52c 100644 --- a/src/doc/tarpl/vec-insert-remove.md +++ b/src/doc/nomicon/vec-insert-remove.md diff --git a/src/doc/tarpl/vec-into-iter.md b/src/doc/nomicon/vec-into-iter.md index ebb0a79bb65..ebb0a79bb65 100644 --- a/src/doc/tarpl/vec-into-iter.md +++ b/src/doc/nomicon/vec-into-iter.md diff --git a/src/doc/tarpl/vec-layout.md b/src/doc/nomicon/vec-layout.md index 3df63d5249c..3df63d5249c 100644 --- a/src/doc/tarpl/vec-layout.md +++ b/src/doc/nomicon/vec-layout.md diff --git a/src/doc/tarpl/vec-push-pop.md b/src/doc/nomicon/vec-push-pop.md index b518e8aa48f..b518e8aa48f 100644 --- a/src/doc/tarpl/vec-push-pop.md +++ b/src/doc/nomicon/vec-push-pop.md diff --git a/src/doc/tarpl/vec-raw.md b/src/doc/nomicon/vec-raw.md index 8f78462cf40..8f78462cf40 100644 --- a/src/doc/tarpl/vec-raw.md +++ b/src/doc/nomicon/vec-raw.md diff --git a/src/doc/tarpl/vec-zsts.md b/src/doc/nomicon/vec-zsts.md index 72e8a34488b..72e8a34488b 100644 --- a/src/doc/tarpl/vec-zsts.md +++ b/src/doc/nomicon/vec-zsts.md diff --git a/src/doc/tarpl/vec.md b/src/doc/nomicon/vec.md index 63f83788c4b..63f83788c4b 100644 --- a/src/doc/tarpl/vec.md +++ b/src/doc/nomicon/vec.md diff --git a/src/doc/tarpl/working-with-unsafe.md b/src/doc/nomicon/working-with-unsafe.md index b20dff72e1c..b20dff72e1c 100644 --- a/src/doc/tarpl/working-with-unsafe.md +++ b/src/doc/nomicon/working-with-unsafe.md diff --git a/src/doc/tarpl/README.md b/src/doc/tarpl/README.md deleted file mode 100644 index e4a46827f46..00000000000 --- a/src/doc/tarpl/README.md +++ /dev/null @@ -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/ |
