Merge branch 'master' of github.com:rust-lang/book

Author: Alexis Hunt

.travis.yml

@@ -13,6 +13,6 @@ addons:
       - aspell
       - aspell-en
 before_script:
-  - (cargo install mdbook --vers 0.0.26 --force || true)
+  - (cargo install mdbook --vers 0.1.2 --force || true)
 script:
   - bash ci/build.sh

README.md

@@ -1,7 +1,7 @@
 # NOTICE ABOUT STATUS
 
 The second edition of The Rust Programming Language is getting ever closer to being printed!
-This means we're not able to make large changes to chapters that are in any column to the 
+This means we're not able to make large changes to chapters that are in any column to the
 right of, and including, the "Frozen" column [on our Project board][proj]. Issues or pull
 requests submitted for frozen chapters are welcome but will be closed until we start work
 on a third edition. Thank you!
@@ -12,22 +12,18 @@ on a third edition. Thank you!
 
 [![Build Status](https://travis-ci.org/rust-lang/book.svg?branch=master)](https://travis-ci.org/rust-lang/book)
 
-This repo contains two editions of “The Rust Programming Language”.
+This repo contains two editions of “The Rust Programming Language”; we
+recommend starting with the second edition.
 
-The second edition is a rewrite that will be printed by NoStarch Press,
-available around October 2017.
+The second edition is a rewrite that will be printed by No Starch Press,
+available around May 2018. Check [the No Starch Page][nostarch] for the latest
+information on the release date and how to order.
 
-[You can read the very latest online][html]; the last few chapters aren't completed yet, but
-the first half of the book is much improved from the first edition. We recommend
-starting with the second edition.
+[nostarch]: https://nostarch.com/rust
 
-[html]: http://rust-lang.github.io/book/
-
-Note that links to the standard library won't work in this version; this is intentional
-so that links work with the book and API docs shipped with Rust installations for offline
-reading. For a version of the book where these links do work, please see the book as shipped
-with the latest [stable], [beta], or [nightly] Rust releases. Be aware that issues in those
-versions may have been fixed in this repository already.
+You can read the book for free online! Please see the book as shipped with the
+latest [stable], [beta], or [nightly] Rust releases. Be aware that issues in
+those versions may have been fixed in this repository already.
 
 [stable]: https://doc.rust-lang.org/stable/book/second-edition/
 [beta]: https://doc.rust-lang.org/beta/book/second-edition/

first-edition/book.toml

@@ -1,2 +1,6 @@
+[book]
 title = "The Rust Programming Language"
 author = "The Rust Project Developers"
+
+[output.html]
+additional-css = ["src/theme/first-edition.css"]

first-edition/src/const-and-static.md

@@ -38,6 +38,9 @@ reference stored in a static has a [`'static` lifetime][lifetimes]:
 static NAME: &'static str = "Steve";
 ```
 
+The type of a `static` value must be `Sync` unless the `static` value is
+mutable.
+
 [lifetimes]: lifetimes.html
 
 ## Mutability
@@ -64,17 +67,20 @@ unsafe {
 
 [unsafe]: unsafe.html
 
-Furthermore, any type stored in a `static` must be `Sync`, and must not have
-a [`Drop`][drop] implementation.
-
-[drop]: drop.html
-
 # Initializing
 
 Both `const` and `static` have requirements for giving them a value. They must
 be given a value that’s a constant expression. In other words, you cannot use
 the result of a function call or anything similarly complex or at runtime.
 
+# Dropping
+
+Types implementing [`Drop`][drop] are allowed in `const` and `static`
+definitions. Constants are inlined where they are used and are dropped
+accordingly. `static` values are not dropped.
+
+[drop]: drop.html
+
 # Which construct should I use?
 
 Almost always, if you can choose between the two, choose `const`. It’s pretty

first-edition/src/ffi.md

@@ -570,7 +570,7 @@ against `libc` and `libm` by default.
 In C, functions can be 'variadic', meaning they accept a variable number of arguments. This can
 be achieved in Rust by specifying `...` within the argument list of a foreign function declaration:
 
-```no_run
+```rust,no_run
 extern {
     fn foo(x: i32, ...);
 }
@@ -584,7 +584,7 @@ fn main() {
 
 Normal Rust functions can *not* be variadic:
 
-```ignore
+```rust,ignore
 // This will not compile
 
 fn foo(x: i32, ...) { }
@@ -750,7 +750,7 @@ extern "C" {
 # fn main() {}
 ```
 
-By including a private field and no constructor, 
+By including a private field and no constructor,
 we create an opaque type that we can’t instantiate outside of this module.
 An empty array is both zero-size and compatible with `#[repr(C)]`.
 But because our `Foo` and `Bar` types are

first-edition/src/procedural-macros.md

@@ -267,8 +267,8 @@ fn impl_hello_world(ast: &syn::DeriveInput) -> quote::Tokens {
             }
         }
     } else {
-        //Nope. This is an Enum. We cannot handle these!
-       panic!("#[derive(HelloWorld)] is only defined for structs, not for enums!");
+        // Nope. This is an Enum. We cannot handle these!
+        panic!("#[derive(HelloWorld)] is only defined for structs, not for enums!");
     }
 }
 ```

first-edition/src/the-stack-and-the-heap.md

@@ -240,7 +240,7 @@ like this:
 | 1                    | y    | 42                     |
 | 0                    | x    | → (2<sup>30</sup>) - 1 |
 
-We have (2<sup>30</sup>) addresses in our hypothetical computer with 1GB of RAM. And since
+We have (2<sup>30</sup>) addresses in our hypothetical computer with 1GiB of RAM. And since
 our stack grows from zero, the easiest place to allocate memory is from the
 other end. So our first value is at the highest place in memory. And the value
 of the struct at `x` has a [raw pointer][rawpointer] to the place we’ve

first-edition/src/theme/first-edition.css

@@ -0,0 +1,56 @@
+.warning {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+    background-color: rgb(242, 222, 222);
+    border-bottom-color: rgb(238, 211, 215);
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-bottom-style: solid;
+    border-bottom-width: 0.666667px;
+    border-image-outset: 0 0 0 0;
+    border-image-repeat: stretch stretch;
+    border-image-slice: 100% 100% 100% 100%;
+    border-image-source: none;
+    border-image-width: 1 1 1 1;
+    border-left-color: rgb(238, 211, 215);
+    border-left-style: solid;
+    border-left-width: 0.666667px;
+    border-right-color: rgb(238, 211, 215);
+    border-right-style: solid;
+    border-right-width: 0.666667px;
+    border-top-color: rgb(238, 211, 215);
+    border-top-left-radius: 4px;
+    border-top-right-radius: 4px;
+    border-top-style: solid;
+    border-top-width: 0.666667px;
+    color: rgb(185, 74, 72);
+    margin-bottom: 0px;
+    margin-left: 0px;
+    margin-right: 0px;
+    margin-top: 30px;
+    padding-bottom: 8px;
+    padding-left: 14px;
+    padding-right: 35px;
+    padding-right: 14px;
+    padding-top: 8px;
+}
+.warning strong {
+    color: rgb(185, 74, 72)
+}
+.warning a {
+    color: rgb(0, 136, 204)
+}
+.warning .message {
+    margin-right: 14px;
+}
+.warning .message:last-child {
+    margin-right: 21px;
+}
+.warning .button {
+    border: none;
+    background: none;
+    color: inherit;
+    cursor: pointer;
+    font-size: 14px;
+}

first-edition/src/theme/header.hbs

@@ -0,0 +1,27 @@
+<div id="draft-warning" class="warning">
+    <span class="message">You are reading an <strong>outdated</strong> edition of TRPL. For more, go <a href="../index.html">here</a>.</span>
+    <button type="button" id="hide-draft-warning" title="Hide draft warning" class="button">
+        <i class="fa fa-times"></i>
+    </button>
+</div>
+<!-- Hide / unhide warning before it is displayed -->
+<script type="text/javascript">
+var warning = localStorage.getItem('trpl-first-edition-draft-warning');
+
+if (warning === 'hidden') {
+    Array
+    .from(document.querySelectorAll('#page-wrapper'))
+    .forEach(function(block) { block.classList.remove('has-warning'); });
+    var elem = document.getElementById("draft-warning");
+    elem.parentNode.removeChild(elem);
+}
+
+document.addEventListener("DOMContentLoaded", function(event) { 
+    document.getElementById("hide-draft-warning").addEventListener("click", function(e) {
+        var elem = document.getElementById("draft-warning");
+        elem.parentNode.removeChild(elem);
+
+        localStorage.setItem('trpl-first-edition-draft-warning', 'hidden');
+    });
+});
+</script>

index.md

@@ -1,11 +1,25 @@
-% The Rust Programming Language
+# The Rust Programming Language
 
-There are two editions of "The Rust Programming Language":
+The current edition of "The Rust Programming Language" is the second
+edition, which you can [read here](second-edition/index.html).
 
-* [First edition](first-edition/index.html)
-* [Second edition](second-edition/index.html)
+The source for all editions lives [on GitHub](https://github.com/rust-lang/book).
+Please open issues with any questions, concerns, or tweaks.
 
-The second edition is a complete re-write. It is still under construction,
-though it is far enough along to learn most of Rust. We suggest reading the
-second edition and then checking out the first edition later to pick up some of
-the more esoteric parts of the language.
+## Notes
+
+The second edition is still receiving some minor edits, but is effectively
+complete. It will be [available in dead-tree form through NoStarch
+Press](https://nostarch.com/Rust) once these final edits are complete.
+
+The second edition is a complete re-write of TRPL, from the ground up,
+and is therefore very different from the first edition.
+
+## Other editions
+
+We keep older editions of TRPL online for history's sake.
+
+### First Edition
+
+You can [read the first edition of "The Rust Programming Language"
+here](first-edition/index.html).