Merge pull request #282 from JohnTitor/reorganize-chapters

Reorganize some chapters

Author: ehuss

README.md

@@ -19,22 +19,22 @@ 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.
 
-### Requirements
+## Requirements
 
 Building the Nomicon requires [mdBook]. To get it:
 
 [mdBook]: https://github.com/rust-lang/mdBook
 
 ```bash
-$ cargo install mdbook
+cargo install mdbook
 ```
 
 ### `mdbook` usage
 
 To build the Nomicon use the `build` sub-command:
 
 ```bash
-$ mdbook build
+mdbook build
 ```
 
 The output will be placed in the `book` subdirectory. To check it out, open the
@@ -43,13 +43,23 @@ build` and it'll open the index page in your default browser (if the process is
 successful) just like with `cargo doc --open`:
 
 ```bash
-$ mdbook build --open
+mdbook build --open
 ```
 
 There is also a `test` sub-command to test all code samples contained in the book:
 
 ```bash
-$ mdbook test
+mdbook test
+```
+
+### `linkcheck`
+
+We use the `linkcheck` tool to find broken links.
+To run it locally:
+
+```sh
+curl -sSLo linkcheck.sh https://raw.githubusercontent.com/rust-lang/rust/master/src/tools/linkchecker/linkcheck.sh
+sh linkcheck.sh --all nomicon
 ```
 
 ## Contributing

book.toml

@@ -6,5 +6,29 @@ description = "The Dark Arts of Advanced and Unsafe Rust Programming"
 [output.html]
 git-repository-url = "https://github.com/rust-lang/nomicon"
 
+[output.html.redirect]
+# Vec-related chapters.
+"./vec-alloc.html" = "./vec/vec-alloc.html"
+"./vec-dealloc.html" = "./vec/vec-dealloc.html"
+"./vec-deref.html" = "./vec/vec-deref.html"
+"./vec-drain.html" = "./vec/vec-drain.html"
+"./vec-final.html" = "./vec/vec-final.html"
+"./vec-insert-remove.html" = "./vec/vec-insert-remove.html"
+"./vec-into-iter.html" = "./vec/vec-into-iter.html"
+"./vec-layout.html" = "./vec/vec-layout.html"
+"./vec-push-pop.html" = "./vec/vec-push-pop.html"
+"./vec-raw.html" = "./vec/vec-raw.html"
+"./vec-zsts.html" = "./vec/vec-zsts.html"
+"./vec.html" = "./vec/vec.html"
+
+# Arc and Mutex related chapters.
+"./arc-and-mutex.html" = "./arc-mutex/arc-and-mutex.html"
+"./arc-base.html" = "./arc-mutex/arc-base.html"
+"./arc-clone.html" = "./arc-mutex/arc-clone.html"
+"./arc-drop.html" = "./arc-mutex/arc-drop.html"
+"./arc-final.html" = "./arc-mutex/arc-final.html"
+"./arc-layout.html" = "./arc-mutex/arc-layout.html"
+"./arc.html" = "./arc-mutex/arc.html"
+
 [rust]
 edition = "2018"

src/README.md

@@ -1,6 +1,6 @@
 # Summary
 
-[Introduction](README.md)
+[Introduction](intro.md)
 
 * [Meet Safe and Unsafe](meet-safe-and-unsafe.md)
   * [How Safe and Unsafe Interact](safe-unsafe-meaning.md)
@@ -42,25 +42,25 @@
   * [Races](races.md)
   * [Send and Sync](send-and-sync.md)
   * [Atomics](atomics.md)
-* [Implementing Vec](vec.md)
-  * [Layout](vec-layout.md)
-  * [Allocating](vec-alloc.md)
-  * [Push and Pop](vec-push-pop.md)
-  * [Deallocating](vec-dealloc.md)
-  * [Deref](vec-deref.md)
-  * [Insert and Remove](vec-insert-remove.md)
-  * [IntoIter](vec-into-iter.md)
-  * [RawVec](vec-raw.md)
-  * [Drain](vec-drain.md)
-  * [Handling Zero-Sized Types](vec-zsts.md)
-  * [Final Code](vec-final.md)
-* [Implementing Arc and Mutex](arc-and-mutex.md)
-  * [Arc](arc.md)
-    * [Layout](arc-layout.md)
-    * [Base Code](arc-base.md)
-    * [Cloning](arc-clone.md)
-    * [Dropping](arc-drop.md)
-    * [Final Code](arc-final.md)
+* [Implementing Vec](./vec/vec.md)
+  * [Layout](./vec/vec-layout.md)
+  * [Allocating](./vec/vec-alloc.md)
+  * [Push and Pop](./vec/vec-push-pop.md)
+  * [Deallocating](./vec/vec-dealloc.md)
+  * [Deref](./vec/vec-deref.md)
+  * [Insert and Remove](./vec/vec-insert-remove.md)
+  * [IntoIter](./vec/vec-into-iter.md)
+  * [RawVec](./vec/vec-raw.md)
+  * [Drain](./vec/vec-drain.md)
+  * [Handling Zero-Sized Types](./vec/vec-zsts.md)
+  * [Final Code](./vec/vec-final.md)
+* [Implementing Arc and Mutex](./arc-mutex/arc-and-mutex.md)
+  * [Arc](./arc-mutex/arc.md)
+    * [Layout](./arc-mutex/arc-layout.md)
+    * [Base Code](./arc-mutex/arc-base.md)
+    * [Cloning](./arc-mutex/arc-clone.md)
+    * [Dropping](./arc-mutex/arc-drop.md)
+    * [Final Code](./arc-mutex/arc-final.md)
 * [FFI](ffi.md)
 * [Beneath `std`](beneath-std.md)
   * [#[panic_handler]](panic-handler.md)

src/SUMMARY.md

@@ -2,6 +2,6 @@
 
 Knowing the theory is all fine and good, but the *best* way to understand
 something is to use it. To better understand atomics and interior mutability,
-we'll be implementing versions of the standard library's Arc and Mutex types.
+we'll be implementing versions of the standard library's `Arc` and `Mutex` types.
 
-TODO: Mutex
+TODO: Write `Mutex` chapters.

src/arc-and-mutex.md renamed to src/arc-mutex/arc-and-mutex.md

@@ -34,7 +34,7 @@ impl<T> Arc<T> {
 Since we're building a concurrency primitive, we'll need to be able to send it
 across threads. Thus, we can implement the `Send` and `Sync` marker traits. For
 more information on these, see [the section on `Send` and
-`Sync`](send-and-sync.md).
+`Sync`](../send-and-sync.md).
 
 This is okay because:
 * You can only get a mutable reference to the value inside an `Arc` if and only

src/arc-base.md renamed to src/arc-mutex/arc-base.md

@@ -26,7 +26,7 @@ happens-before relationship but is atomic. When `Drop`ping the Arc, however,
 we'll need to atomically synchronize when decrementing the reference count. This
 is described more in [the section on the `Drop` implementation for
 `Arc`](arc-drop.md). For more information on atomic relationships and Relaxed
-ordering, see [the section on atomics](atomics.md).
+ordering, see [the section on atomics](../atomics.md).
 
 Thus, the code becomes this:
 

src/arc-clone.md renamed to src/arc-mutex/arc-clone.md

@@ -41,7 +41,7 @@ be used where an `Arc<&'a str>` was expected. More importantly, it will give
 incorrect ownership information to the drop checker, as it will assume we don't
 own any values of type `T`. As this is a structure providing shared ownership of
 a value, at some point there will be an instance of this structure that entirely
-owns its data. See [the chapter on ownership and lifetimes](ownership.md) for
+owns its data. See [the chapter on ownership and lifetimes](../ownership.md) for
 all the details on variance and drop check.
 
 To fix the first problem, we can use `NonNull<T>`. Note that `NonNull<T>` is a