Browse Source

Prepare for 1.0

Bradlee Speice 5 months ago
parent
commit
b685547ddd
8 changed files with 22 additions and 8 deletions
  1. 2
    0
      .travis.yml
  2. 3
    3
      Cargo.toml
  3. 1
    1
      Makefile
  4. 12
    0
      README.md
  5. 1
    1
      qadapt-macro/Cargo.toml
  6. 1
    1
      qadapt-macro/README.md
  7. 1
    1
      qadapt-spin/Cargo.toml
  8. 1
    1
      qadapt-spin/README.md

+ 2
- 0
.travis.yml View File

@@ -57,6 +57,8 @@ after_success: |
57 57
     if [ -n "$TRAVIS_TAG" ]; then
58 58
         cd qadapt-macro &&
59 59
         cargo publish --token "$CARGO_TOKEN" &&
60
+        cd ../qadapt-spin &&
61
+        cargo publish --token "$CARGO_TOKEN" &&
60 62
         cd .. &&
61 63
         cargo publish --token "$CARGO_TOKEN"
62 64
     elif [ -n "$CODECOV" ] && [ -z "$TRAVIS_TAG" ]; then

+ 3
- 3
Cargo.toml View File

@@ -1,6 +1,6 @@
1 1
 [package]
2 2
 name = "qadapt"
3
-version = "0.7.1"
3
+version = "1.0.0"
4 4
 authors = ["Bradlee Speice <bradlee@speice.io>"]
5 5
 description = "The Quick And Dirty Allocation Profiling Tool"
6 6
 license = "Apache-2.0"
@@ -22,8 +22,8 @@ maintenance = { status = "actively-developed" }
22 22
 libc = "0.2"
23 23
 thread-id = "3.3"
24 24
 
25
-qadapt-macro = { version = "0.7.1", path = "./qadapt-macro" }
26
-qadapt-spin = { version = "0.7.1", path = "./qadapt-spin" }
25
+qadapt-macro = { version = "1.0.0", path = "./qadapt-macro" }
26
+qadapt-spin = { version = "1.0.0", path = "./qadapt-spin" }
27 27
 
28 28
 [dev-dependencies]
29 29
 futures = "0.1"

+ 1
- 1
Makefile View File

@@ -6,7 +6,7 @@ all:
6 6
 contributors:
7 7
 	@echo '`qadapt` is developed by:' > CONTRIBUTORS.md
8 8
 	@echo '  Bradlee Speice <bradlee@speice.io>' >> CONTRIBUTORS.md
9
-	@git log --format='  %aN <%aE>' | grep -v "Bradlee Speice <bradlee@speice.io>" | sort -u >> CONTRIBUTORS.md
9
+	@git log --format='  %aN <%aE>' | grep -v "Bradlee Speice <bradlee@speice.io>" | grep -v "users.noreply" | sort -u >> CONTRIBUTORS.md
10 10
 
11 11
 .PHONY: readme README.md
12 12
 readme: README.md

+ 12
- 0
README.md View File

@@ -39,10 +39,22 @@ After that, there are two ways of telling QADAPT that it should trigger a panic:
39 39
 ```rust,no_run
40 40
 use qadapt::no_alloc;
41 41
 
42
+// This function is fine, there are no allocations here
42 43
 #[no_alloc]
43 44
 fn do_math() -> u8 {
44 45
     2 + 2
45 46
 }
47
+
48
+// This function will trigger a panic when called
49
+#[no_alloc]
50
+fn does_panic() -> Box<u32> {
51
+    Box::new(5)
52
+}
53
+
54
+fn main() {
55
+    do_math();
56
+    does_panic();
57
+}
46 58
 ```
47 59
 
48 60
 2. Evaluate expressions with the `assert_no_alloc!` macro

+ 1
- 1
qadapt-macro/Cargo.toml View File

@@ -1,6 +1,6 @@
1 1
 [package]
2 2
 name = "qadapt-macro"
3
-version = "0.7.1"
3
+version = "1.0.0"
4 4
 authors = ["Bradlee Speice <bradlee@speice.io>"]
5 5
 description = "The Quick And Dirty Allocation Profiling Tool - Support Macros"
6 6
 license = "Apache-2.0"

+ 1
- 1
qadapt-macro/README.md View File

@@ -3,7 +3,7 @@
3 3
 [![crates.io](https://img.shields.io/crates/v/qadapt-macro.svg)](https://crates.io/crates/qadapt-macro)
4 4
 [![docs.rs](https://docs.rs/dtparse/qadapt-macro.svg)](https://docs.rs/qadapt-macro/)
5 5
 
6
-Helper macros to use with the QADAPT allocator system
6
+Helper macro for the QADAPT allocator.
7 7
 
8 8
 This crate is intended for managing the QADAPT allocator,
9 9
 and is unusable on its own.

+ 1
- 1
qadapt-spin/Cargo.toml View File

@@ -1,7 +1,7 @@
1 1
 [package]
2 2
 
3 3
 name = "qadapt-spin"
4
-version = "0.7.1"
4
+version = "1.0.0"
5 5
 authors = [ "Mathijs van de Nes <git@mathijs.vd-nes.nl>",
6 6
             "John Ericson <John_Ericson@Yahoo.com>" ]
7 7
 license = "MIT"

+ 1
- 1
qadapt-spin/README.md View File

@@ -1,4 +1,4 @@
1 1
 qadapt-spin
2 2
 ===========
3 3
 
4
-Placeholder for the [`spin-rs`](https://github.com/mvdnes/spin-rs)
4
+Placeholder for a stable-compatible [`spin-rs`](https://github.com/mvdnes/spin-rs) crate.

Loading…
Cancel
Save