Merge #17

17: make the "inline-asm" feature opt-in r=japaric a=japaric



Co-authored-by: Jorge Aparicio <[email protected]>

Author: bors[bot]

.travis.yml

@@ -3,14 +3,31 @@ language: rust
 matrix:
   include:
     - env: TARGET=x86_64-unknown-linux-gnu
+
+    - env: TARGET=thumbv6m-none-eabi
+      rust: beta
+      addons:
+        apt:
+          packages:
+            - gcc-arm-none-eabi
+
+    - env: TARGET=thumbv7m-none-eabi
+      rust: beta
+      addons:
+        apt:
+          packages:
+            - gcc-arm-none-eabi
+
     - env: TARGET=x86_64-unknown-linux-gnu
       rust: nightly
+
     - env: TARGET=thumbv6m-none-eabi
       rust: nightly
       addons:
         apt:
           packages:
             - gcc-arm-none-eabi
+
     - env: TARGET=thumbv7m-none-eabi
       rust: nightly
       addons:

CHANGELOG.md

@@ -5,6 +5,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [v0.3.0] - 2018-05-10
+
+### Changed
+
+- [breaking-change] `inline-asm` is no longer a default feature (i.e. a feature that's enabled by
+  default). The consequence is that this crate now compiles on 1.27 (beta) by default, and opting
+  into `inline-asm` requires nightly.
+
 ## [v0.2.1] - 2018-04-25
 
 ### Added
@@ -64,7 +72,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 - Initial release
 
-[Unreleased]: https://github.com/japaric/cortex-m-semihosting/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/japaric/cortex-m-semihosting/compare/v0.3.0...HEAD
+[v0.3.0]: https://github.com/japaric/cortex-m-semihosting/compare/v0.2.1...v0.3.0
+[v0.2.1]: https://github.com/japaric/cortex-m-semihosting/compare/v0.2.0...v0.2.1
 [v0.2.0]: https://github.com/japaric/cortex-m-semihosting/compare/v0.1.3...v0.2.0
 [v0.1.3]: https://github.com/japaric/cortex-m-semihosting/compare/v0.1.2...v0.1.3
 [v0.1.2]: https://github.com/japaric/cortex-m-semihosting/compare/v0.1.1...v0.1.2

Cargo.toml

@@ -6,11 +6,10 @@ keywords = ["semihosting", "arm", "cortex-m"]
 license = "MIT OR Apache-2.0"
 name = "cortex-m-semihosting"
 repository = "https://github.com/japaric/cortex-m-semihosting"
-version = "0.2.1"
+version = "0.3.0"
 
 [build-dependencies]
 cc = "1.0.10"
 
 [features]
-inline-asm = []
-default = ["inline-asm"]
+inline-asm = []

ci/script.sh

@@ -1,10 +1,10 @@
 set -euxo pipefail
 
 main() {
-    cargo check --target $TARGET --no-default-features
+    cargo check --target $TARGET
 
-    if [ $TARGET != x86_64-unknown-linux-gnu ]; then
-        cargo check --target $TARGET
+    if [ $TRAVIS_RUST_VERSION = nightly ]; then
+        cargo check --target $TARGET --features inline-asm
     fi
 }
 

src/lib.rs

@@ -18,6 +18,11 @@
 //! Semihosting operations are *very* slow. Like, each WRITE operation can take hundreds of
 //! milliseconds.
 //!
+//! # Requirements
+//!
+//! Compiling this crate on stable or beta requires `arm-none-eabi-gcc` to be installed and
+//! available in `PATH`.
+//!
 //! # Example
 //!
 //! This example will show how to print "Hello, world!" on the host.
@@ -28,7 +33,8 @@
 //! #[macro_use]
 //! extern crate cortex_m_semihosting;
 //!
-//! fn main() {
+//! // This function will be called by the application
+//! fn print() {
 //!     // File descriptor (on the host)
 //!     const STDOUT: usize = 1; // NOTE the host stdout may not always be fd 1
 //!     static MSG: &'static [u8] = b"Hello, world!\n";
@@ -69,16 +75,16 @@
 //!
 //! ``` text
 //! $ arm-none-eabi-gdb hello-world
-//! # Connect to OpenOCD
+//! (gdb) # Connect to OpenOCD
 //! (gdb) target remote :3333
 //!
-//! # Enable OpenOCD's semihosting support
+//! (gdb) # Enable OpenOCD's semihosting support
 //! (gdb) monitor arm semihosting enable
 //!
-//! # Flash the program
+//! (gdb) # Flash the program
 //! (gdb) load
 //!
-//! # Run the program
+//! (gdb) # Run the program
 //! (gdb) continue
 //! ```
 //!
@@ -90,17 +96,15 @@
 //! Hello, world!
 //! ```
 //!
-//! # Cargo features
+//! # Optional features
 //!
 //! ## `inline-asm`
 //!
-//! This feature is *enabled* by default.
-//!
 //! When this feature is enabled semihosting is implemented using inline assembly (`asm!`) and
 //! compiling this crate requires nightly.
 //!
 //! When this feature is disabled semihosting is implemented using FFI calls into an external
-//! assembly file and compiling this crate works on stable.
+//! assembly file and compiling this crate works on stable and beta.
 //!
 //! Apart from the toolchain requirement, disabling `inline-asm` requires `arm-none-eabi-gcc` to be
 //! installed on the host. Also, disabling `inline-asm` imposes an overhead of an extra function
@@ -144,12 +148,14 @@ pub unsafe fn syscall1(_nr: usize, _arg: usize) -> usize {
     match () {
         #[cfg(all(thumb, not(feature = "inline-asm")))]
         () => __syscall(_nr, _arg),
+
         #[cfg(all(thumb, feature = "inline-asm"))]
         () => {
             let mut nr = _nr;
             asm!("bkpt 0xAB" : "+{r0}"(nr) : "{r1}"(_arg) :: "volatile");
             nr
         }
+
         #[cfg(not(thumb))]
         () => unimplemented!(),
     }