document the no #![no_main] issue

This commit is contained in:
Jorge Aparicio
2018-05-13 12:02:37 +02:00
parent 91a894e369
commit 7ae7245956

View File

@@ -135,13 +135,28 @@
//!
//! # Examples
//!
//! Check the [examples module](./examples/index.html)
//! Check the [examples module][examples]
//!
//! [examples]: ./examples/index.html
//!
//! # Troubleshooting
//!
//! This section contains fixes for common errors encountered when the
//! `cortex-m-quickstart` template is misused.
//!
//! ## Used the standard `main` interface
//!
//! Error message:
//!
//! ``` text
//! $ cargo build
//! Compiling demo v0.1.0 (file:///home/japaric/tmp/demo)
//!
//! error: requires `start` lang_item
//! ```
//!
//! Solution: Use `#![no_main]` and `entry!` as shown in the [examples].
//!
//! ## Forgot to launch an OpenOCD instance
//!
//! Error message: