Skip to content

Commit

Permalink
document the no #![no_main] issue
Browse files Browse the repository at this point in the history
  • Loading branch information
japaric committed May 13, 2018
1 parent 91a894e commit 7ae7245
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -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:

0 comments on commit 7ae7245

Please sign in to comment.