Merge #32

32: Build with 2018 edition, and fix the example r=korken89 a=jonas-schievink

r? @therealprof 

Co-authored-by: Jonas Schievink <jonasschievink@gmail.com>

Author: bors[bot]

Cargo.toml

@@ -9,6 +9,7 @@ description = "A heap allocator for Cortex-M processors"
 repository = "https://github.com/rust-embedded/alloc-cortex-m"
 documentation = "https://docs.rs/alloc-cortex-m"
 readme = "README.md"
+edition = "2018"
 
 keywords = [
     "allocator",
@@ -25,3 +26,6 @@ cortex-m = "0.1.5"
 [dependencies.linked_list_allocator]
 default-features = false
 version = "0.8.1"
+
+[dev-dependencies]
+cortex-m-rt = "0.6.12"

ci/script.sh

@@ -1,7 +1,13 @@
+#!/usr/bin/env bash
+
 set -euxo pipefail
 
 main() {
-    cargo check --target $TARGET
+    cargo check --target "$TARGET"
+
+    if [ "$TARGET" != x86_64-unknown-linux-gnu ]; then
+        cargo build --target "$TARGET" --examples
+    fi
 }
 
 main

examples/global_alloc.rs

@@ -0,0 +1,37 @@
+#![no_std]
+#![no_main]
+#![feature(alloc_error_handler)]
+
+extern crate alloc;
+
+use core::panic::PanicInfo;
+use core::alloc::Layout;
+use alloc::vec::Vec;
+use alloc_cortex_m::CortexMHeap;
+use cortex_m_rt::entry;
+
+#[global_allocator]
+static ALLOCATOR: CortexMHeap = CortexMHeap::empty();
+
+#[entry]
+fn main() -> ! {
+    // Initialize the allocator BEFORE you use it
+    let start = cortex_m_rt::heap_start() as usize;
+    let size = 1024; // in bytes
+    unsafe { ALLOCATOR.init(start, size) }
+
+    let mut xs = Vec::new();
+    xs.push(1);
+
+    loop { /* .. */ }
+}
+
+#[alloc_error_handler]
+fn oom(_: Layout) -> ! {
+    loop {}
+}
+
+#[panic_handler]
+fn panic(_: &PanicInfo) -> ! {
+    loop {}
+}

src/lib.rs

@@ -1,58 +1,13 @@
-//! A heap allocator for Cortex-M processors
+//! A heap allocator for Cortex-M processors.
 //!
-//! # Example
-//!
-//! ```
-//! #![feature(alloc)]
-//! #![feature(global_allocator)]
-//! #![feature(lang_items)]
-//!
-//! // Plug in the allocator crate
-//! extern crate alloc;
-//! extern crate alloc_cortex_m;
-//! #[macro_use]
-//! extern crate cortex_m_rt as rt; // v0.5.x
-//!
-//! use alloc::Vec;
-//! use alloc_cortex_m::CortexMHeap;
-//!
-//! #[global_allocator]
-//! static ALLOCATOR: CortexMHeap = CortexMHeap::empty();
-//!
-//! entry!(main);
-//!
-//! fn main() -> ! {
-//!     // Initialize the allocator BEFORE you use it
-//!     let start = rt::heap_start() as usize;
-//!     let size = 1024; // in bytes
-//!     unsafe { ALLOCATOR.init(start, size) }
-//!
-//!     let mut xs = Vec::new();
-//!     xs.push(1);
-//!
-//!     loop { /* .. */ }
-//! }
-//!
-//! // required: define how Out Of Memory (OOM) conditions should be handled
-//! // *if* no other crate has already defined `oom`
-//! #[lang = "oom"]
-//! #[no_mangle]
-//! pub fn rust_oom() -> ! {
-//!     // ..
-//! }
+//! Note that using this as your global allocator requires nightly Rust.
 //!
+//! # Example
 //!
-//! // omitted: exception handlers
-//! ```
+//! For a usage example, see `examples/global_alloc.rs`.
 
-#![feature(allocator_api)]
-#![feature(const_fn)]
 #![no_std]
 
-extern crate alloc;
-extern crate cortex_m;
-extern crate linked_list_allocator;
-
 use core::alloc::{GlobalAlloc, Layout};
 use core::ptr::NonNull;