move code to the 2018 edition

japaric · japaric · commit b917d6439bdc · 2018-09-05T18:09:49.000+02:00
closes #1
diff --git a/ci/exceptions/app/Cargo.toml b/ci/exceptions/app/Cargo.toml
@@ -1,7 +1,10 @@
+cargo-features = ["edition"]
+
 [package]
+authors = ["Jorge Aparicio <jorge@japaric.io>"]
+edition = "2018"
 name = "app"
 version = "0.1.0"
-authors = ["Jorge Aparicio <jorge@japaric.io>"]
 
 [dependencies]
 rt = { path = "../rt" }
diff --git a/ci/exceptions/app/src/main.rs b/ci/exceptions/app/src/main.rs
@@ -2,11 +2,10 @@
 #![no_main]
 #![no_std]
 
-#[macro_use]
-extern crate rt;
-
 use core::intrinsics;
 
+use rt::entry;
+
 entry!(main);
 
 fn main() -> ! {
diff --git a/ci/exceptions/app2/src/main.rs b/ci/exceptions/app2/src/main.rs
@@ -2,11 +2,10 @@
 #![no_main]
 #![no_std]
 
-#[macro_use]
-extern crate rt;
-
 use core::intrinsics;
 
+use rt::entry;
+
 entry!(main);
 
 fn main() -> ! {
diff --git a/ci/exceptions/rt/src/lib.rs b/ci/exceptions/rt/src/lib.rs
@@ -37,7 +37,7 @@ pub unsafe extern "C" fn Reset() -> ! {
 pub static RESET_VECTOR: unsafe extern "C" fn() -> ! = Reset;
 
 #[panic_handler]
-fn panic(_panic: &PanicInfo) -> ! {
+fn panic(_panic: &PanicInfo<'_>) -> ! {
     loop {}
 }
 
diff --git a/ci/main/app/Cargo.toml b/ci/main/app/Cargo.toml
@@ -1,4 +1,7 @@
+cargo-features = ["edition"] # <-
+
 [package]
+edition = "2018" # <-
 name = "app"
 version = "0.1.0"
 authors = ["Jorge Aparicio <jorge@japaric.io>"]
diff --git a/ci/main/app2/src/main.rs b/ci/main/app2/src/main.rs
@@ -1,8 +1,7 @@
 #![no_std]
 #![no_main]
 
-#[macro_use]
-extern crate rt;
+use rt::entry;
 
 entry!(main);
 
diff --git a/ci/main/app3/src/main.rs b/ci/main/app3/src/main.rs
@@ -1,8 +1,7 @@
 #![no_std]
 #![no_main]
 
-#[macro_use]
-extern crate rt;
+use rt::entry;
 
 entry!(main);
 
diff --git a/ci/main/app4/Cargo.toml b/ci/main/app4/Cargo.toml
@@ -1,7 +1,10 @@
+cargo-features = ["edition"]
+
 [package]
+authors = ["Jorge Aparicio <jorge@japaric.io>"]
+edition = "2018"
 name = "app"
 version = "0.1.0"
-authors = ["Jorge Aparicio <jorge@japaric.io>"]
 
 [dependencies]
 rt = { path = "../rt2" }
diff --git a/ci/main/app4/src/main.rs b/ci/main/app4/src/main.rs
@@ -2,11 +2,10 @@
 #![no_main]
 #![no_std]
 
-#[macro_use]
-extern crate rt;
-
 use core::ptr;
 
+use rt::entry;
+
 entry!(main);
 
 static mut DATA: i32 = 1;
diff --git a/ci/main/rt/Cargo.toml b/ci/main/rt/Cargo.toml
@@ -1,6 +1,9 @@
+cargo-features = ["edition"]
+
 [package]
-name = "rt"
-version = "0.1.0"
+name = "rt" # <-
 authors = ["Jorge Aparicio <jorge@japaric.io>"]
+edition = "2018"
+version = "0.1.0"
 
 [dependencies]
diff --git a/ci/main/rt/src/lib.rs b/ci/main/rt/src/lib.rs
@@ -19,7 +19,7 @@ pub unsafe extern "C" fn Reset() -> ! {
 pub static RESET_VECTOR: unsafe extern "C" fn() -> ! = Reset;
 
 #[panic_handler]
-fn panic(_panic: &PanicInfo) -> ! {
+fn panic(_panic: &PanicInfo<'_>) -> ! {
     loop {}
 }
 
diff --git a/ci/main/rt2/src/lib.rs b/ci/main/rt2/src/lib.rs
@@ -37,7 +37,7 @@ pub unsafe extern "C" fn Reset() -> ! {
 pub static RESET_VECTOR: unsafe extern "C" fn() -> ! = Reset;
 
 #[panic_handler]
-fn panic(_panic: &PanicInfo) -> ! {
+fn panic(_panic: &PanicInfo<'_>) -> ! {
     loop {}
 }
 
diff --git a/ci/memory-layout/src/main.rs b/ci/memory-layout/src/main.rs
@@ -19,6 +19,6 @@ pub unsafe extern "C" fn Reset() -> ! {
 pub static RESET_VECTOR: unsafe extern "C" fn() -> ! = Reset;
 
 #[panic_handler]
-fn panic(_panic: &PanicInfo) -> ! {
+fn panic(_panic: &PanicInfo<'_>) -> ! {
     loop {}
 }
diff --git a/ci/script.sh b/ci/script.sh
@@ -23,6 +23,8 @@ main() {
     diff app.o.nm \
          <(cargo nm -- target/thumbv7m-none-eabi/debug/deps/app-*.o | grep '[0-9]* [^n] ')
 
+    edition_check
+
     popd
 
     # # memory-layout
@@ -38,6 +40,8 @@ main() {
 
     qemu_check target/thumbv7m-none-eabi/debug/app
 
+    edition_check
+
     popd
 
     # # main
@@ -47,20 +51,25 @@ main() {
     pushd app
     diff app.objdump \
          <(cargo objdump --bin app -- -d -no-show-raw-insn)
+    # disabled because of rust-lang/rust#53964
+    # edition_check
     popd
 
     # check that it builds
     pushd app2
     cargo build
+    edition_check
     popd
 
     pushd app3
     cargo build
+    edition_check
     popd
 
     pushd app4
     cargo build
     qemu_check target/thumbv7m-none-eabi/debug/app
+    edition_check
     popd
 
     popd
@@ -72,16 +81,23 @@ main() {
     pushd app
     diff app.vector_table.objdump \
          <(cargo objdump --bin app --release -- -s -j .vector_table)
+    edition_check
     popd
 
     # check that it builds
     pushd app2
     cargo build
+    edition_check
     popd
 
     popd
 }
 
+# checks that 2018 idioms are being used
+edition_check() {
+    RUSTFLAGS="-D rust_2018_compatibility -D rust_2018_idioms" cargo check
+}
+
 # checks that QEMU doesn't crash and that it produces no error messages
 qemu_check() {
     qemu-system-arm \
diff --git a/ci/smallest-no-std/Cargo.toml b/ci/smallest-no-std/Cargo.toml
@@ -1,6 +1,9 @@
+cargo-features = ["edition"] # <-
+
 [package]
-authors = ["Jorge Aparicio <jorge@japaric.io>"]
+edition = "2018" # <-
 name = "app"
+authors = ["Jorge Aparicio <jorge@japaric.io>"]
 version = "0.1.0"
 
 [dependencies]
diff --git a/ci/smallest-no-std/src/main.rs b/ci/smallest-no-std/src/main.rs
@@ -5,6 +5,6 @@
 use core::panic::PanicInfo;
 
 #[panic_handler]
-fn panic(_panic: &PanicInfo) -> ! {
+fn panic(_panic: &PanicInfo<'_>) -> ! {
     loop {}
 }
diff --git a/src/main.md b/src/main.md
@@ -15,11 +15,11 @@ And then rename it to `rt` which stands for "runtime".
 ``` console
 $ sed -i s/app/rt/ Cargo.toml
 
-$ head -n2 Cargo.toml
+$ head -n5 Cargo.toml
 ```
 
 ``` toml
-{{#include ../ci/main/rt/Cargo.toml:1:2}}
+{{#include ../ci/main/rt/Cargo.toml:1:5}}
 ```
 
 The first change is to have the reset handler call an external `main` function:
@@ -67,6 +67,15 @@ $ cargo new --bin app
 
 $ cd app
 
+$ # again, don't forget to move the project to the 2018 edition
+$ head -n5 Cargo.toml
+```
+
+``` toml
+{{#include ../ci/main/app/Cargo.toml:1:5}}
+```
+
+``` console
 $ cargo add rt --path ../rt
 
 $ # copy over the config file that sets a default target and tweaks the linker invocation
diff --git a/src/preface.md b/src/preface.md
@@ -42,6 +42,23 @@ nor is access to a Cortex-M microcontroller needed -- all the examples included
 QEMU. You will, however, need to install the following tools to run and inspect the examples in this
 book:
 
+- All the code in this book uses the 2018 edition. If you are not familiar with
+the 2018 features and idioms check [the edition guide]. Please also note that
+until the 2018 edition is officially released you'll have to *manually modify
+the Cargo.toml of new projects* to make use the 2018 edition. The required
+changes are shown below:
+
+[the edition guide]: https://rust-lang-nursery.github.io/edition-guide/
+
+``` diff
++cargo-features = ["edition"]
++
+ [package]
++edition = "2018"
+ name = "hello"
+ version = "0.1.0"
+```
+
 - A nightly toolchain from 2018-08-28 or newer.
 
 - [`cargo-binutils`](https://github.com/japaric/cargo-binutils). v0.1.2 or newer.
diff --git a/src/smallest-no-std.md b/src/smallest-no-std.md
@@ -44,6 +44,15 @@ $ cargo new --bin app
 
 $ cd app
 
+$ # don't forget to move the project to the 2018 edition
+$ head -n5 Cargo.toml
+```
+
+``` toml
+{{#include ../ci/smallest-no-std/Cargo.toml:1:5}}
+```
+
+``` console
 $ # modify main.rs so it has these contents
 $ cat src/main.rs
 ```

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ pub unsafe extern "C" fn Reset() -> ! {`
`37`	`37`	`pub static RESET_VECTOR: unsafe extern "C" fn() -> ! = Reset;`
`38`	`38`
`39`	`39`	`#[panic_handler]`
`40`		`-fn panic(_panic: &PanicInfo) -> ! {`
	`40`	`+fn panic(_panic: &PanicInfo<'_>) -> ! {`
`41`	`41`	`loop {}`
`42`	`42`	`}`
`43`	`43`