From b685547ddddac614875e2d3a268b8fd6c4977ece Mon Sep 17 00:00:00 2001 From: Bradlee Speice Date: Sat, 15 Dec 2018 16:12:06 -0500 Subject: [PATCH] Prepare for 1.0 --- .travis.yml | 2 ++ Cargo.toml | 6 +++--- Makefile | 2 +- README.md | 12 ++++++++++++ qadapt-macro/Cargo.toml | 2 +- qadapt-macro/README.md | 2 +- qadapt-spin/Cargo.toml | 2 +- qadapt-spin/README.md | 2 +- 8 files changed, 22 insertions(+), 8 deletions(-) diff --git a/.travis.yml b/.travis.yml index 159fc2a..bbac569 100644 --- a/.travis.yml +++ b/.travis.yml @@ -57,6 +57,8 @@ after_success: | if [ -n "$TRAVIS_TAG" ]; then cd qadapt-macro && cargo publish --token "$CARGO_TOKEN" && + cd ../qadapt-spin && + cargo publish --token "$CARGO_TOKEN" && cd .. && cargo publish --token "$CARGO_TOKEN" elif [ -n "$CODECOV" ] && [ -z "$TRAVIS_TAG" ]; then diff --git a/Cargo.toml b/Cargo.toml index 3328cc4..a8d39eb 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "qadapt" -version = "0.7.1" +version = "1.0.0" authors = ["Bradlee Speice "] description = "The Quick And Dirty Allocation Profiling Tool" license = "Apache-2.0" @@ -22,8 +22,8 @@ maintenance = { status = "actively-developed" } libc = "0.2" thread-id = "3.3" -qadapt-macro = { version = "0.7.1", path = "./qadapt-macro" } -qadapt-spin = { version = "0.7.1", path = "./qadapt-spin" } +qadapt-macro = { version = "1.0.0", path = "./qadapt-macro" } +qadapt-spin = { version = "1.0.0", path = "./qadapt-spin" } [dev-dependencies] futures = "0.1" diff --git a/Makefile b/Makefile index 8fc2aa7..5b8a52b 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ all: contributors: @echo '`qadapt` is developed by:' > CONTRIBUTORS.md @echo ' Bradlee Speice ' >> CONTRIBUTORS.md - @git log --format=' %aN <%aE>' | grep -v "Bradlee Speice " | sort -u >> CONTRIBUTORS.md + @git log --format=' %aN <%aE>' | grep -v "Bradlee Speice " | grep -v "users.noreply" | sort -u >> CONTRIBUTORS.md .PHONY: readme README.md readme: README.md diff --git a/README.md b/README.md index 52790f5..9532b79 100644 --- a/README.md +++ b/README.md @@ -39,10 +39,22 @@ After that, there are two ways of telling QADAPT that it should trigger a panic: ```rust,no_run use qadapt::no_alloc; +// This function is fine, there are no allocations here #[no_alloc] fn do_math() -> u8 { 2 + 2 } + +// This function will trigger a panic when called +#[no_alloc] +fn does_panic() -> Box { + Box::new(5) +} + +fn main() { + do_math(); + does_panic(); +} ``` 2. Evaluate expressions with the `assert_no_alloc!` macro diff --git a/qadapt-macro/Cargo.toml b/qadapt-macro/Cargo.toml index 580947f..f160483 100644 --- a/qadapt-macro/Cargo.toml +++ b/qadapt-macro/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "qadapt-macro" -version = "0.7.1" +version = "1.0.0" authors = ["Bradlee Speice "] description = "The Quick And Dirty Allocation Profiling Tool - Support Macros" license = "Apache-2.0" diff --git a/qadapt-macro/README.md b/qadapt-macro/README.md index 2cfb93b..e84994c 100644 --- a/qadapt-macro/README.md +++ b/qadapt-macro/README.md @@ -3,7 +3,7 @@ [![crates.io](https://img.shields.io/crates/v/qadapt-macro.svg)](https://crates.io/crates/qadapt-macro) [![docs.rs](https://docs.rs/dtparse/qadapt-macro.svg)](https://docs.rs/qadapt-macro/) -Helper macros to use with the QADAPT allocator system +Helper macro for the QADAPT allocator. This crate is intended for managing the QADAPT allocator, and is unusable on its own. \ No newline at end of file diff --git a/qadapt-spin/Cargo.toml b/qadapt-spin/Cargo.toml index 9b2b165..aa81492 100644 --- a/qadapt-spin/Cargo.toml +++ b/qadapt-spin/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "qadapt-spin" -version = "0.7.1" +version = "1.0.0" authors = [ "Mathijs van de Nes ", "John Ericson " ] license = "MIT" diff --git a/qadapt-spin/README.md b/qadapt-spin/README.md index 4336571..9fe749f 100644 --- a/qadapt-spin/README.md +++ b/qadapt-spin/README.md @@ -1,4 +1,4 @@ qadapt-spin =========== -Placeholder for the [`spin-rs`](https://github.com/mvdnes/spin-rs) +Placeholder for a stable-compatible [`spin-rs`](https://github.com/mvdnes/spin-rs) crate.