Merge pull request #16 from simbleau/v1.1.3

v1.1.3 - Changed to stable

CHANGELOG.md

@@ -1,70 +1,138 @@
 
 # Change Log
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.1.2] - 2023-07-23
+
+There are no update steps from the previous version.
+
+### Added
+
+- Nothing
+
+### Changed
+
+- The crate is now using the stable coolchain
+
+### Fixed
+
+- Nothing
+
 ## [1.1.1] - 2022-07-10
+
 There are no update steps from the previous version.
+
 ### Added
+
 - Nothing
+
 ### Changed
+
 - The crate is now `#![no_std]`
+
 ### Fixed
+
+- Nothing
+
+## [1.1.1] - 2022-07-10
+
+There are no update steps from the previous version.
+
+### Added
+
+- Nothing
+
+### Changed
+
+- The crate is now `#![no_std]`
+
+### Fixed
+
 - Nothing
 
 ---
 
 ## [1.1.0] - 2022-05-30
+
 There are no update steps from the previous version.
+
 ### Added
+
 - Users can now annotate thread names with `name_thread!(...)` to wrap the canonical `nvtxNameOsThread(uint32_t, const *char)` from NVTX.
+
 ### Changed
+
 - Nothing
+
 ### Fixed
+
 - Nothing
 
 ---
 
 ## [1.0.0] - 2022-05-29
+
 To update, replace your function calls with macros, e.g. `range_push("hello")` becomes `range_push!("hello")`
+
 ### Added
+
 - Nothing
+
 ### Changed
+
 - The `range_push(&str)` function was changed to `range_push!(...)` which uses argument format capturing similar to the `println!(...)` macro. This is a breaking change.
 - The `range_pop()` function was changed to `range_push!()`. This is a breaking change.
 - The `mark(&str)` function was changed to `mark!(...)` which uses argument format capturing similar to the `println!(...)` macro. This is a breaking change.
+
 ### Fixed
+
 - Nothing
 
 ---
 
 ## [0.2.0] - 2021-05-24
+
 There are no update steps from the previous version.
+
 ### Added
+
 - [Feature](https://github.com/simbleau/nvtx/blob/ab656ade3db26c7aea4346ec975730261b6dcd6d/src/lib.rs#L73)
   Users can use the method `mark(&str)` to wrap the canonical `nvtxMarkA(const *char)` from NVTX.
 - [Example](https://github.com/simbleau/nvtx/blob/ab656ade3db26c7aea4346ec975730261b6dcd6d/examples/mark)
   Added an example which uses marks.
 - [Example](https://github.com/simbleau/nvtx/blob/ab656ade3db26c7aea4346ec975730261b6dcd6d/examples/thread_range)
   Added an example which uses thread ranges.
+
 ### Changed
+
 - [Hello, World!](https://github.com/simbleau/nvtx/blob/ab656ade3db26c7aea4346ec975730261b6dcd6d/examples/hello_world)
   Changed the structure of the example to hold its own folder and README.
+
 ### Fixed
+
 - Nothing
 
 ---
 
 ## [0.1.0] - 2021-05-24
+
 There are no update steps to advance to this version as this is the first version.
+
 ### Added
+
 - [Feature](https://github.com/simbleau/nvtx/blob/8966d0cf05338c4472657119bf8277fd2f59cc69/src/lib.rs#L38)
   Users can use the method `range_push(&str)` to wrap the canonical `nvtxRangePushA(const *char)` from NVTX.
 - [Feature](https://github.com/simbleau/nvtx/blob/8966d0cf05338c4472657119bf8277fd2f59cc69/src/lib.rs#L57)
   Users can use the method `range_pop()` to wrap the canonical `nvtxRangePop(void)` from NVTX.
+
 ### Changed
+
 - Nothing
+
 ### Fixed
-- Nothing
+
+- Nothing

Cargo.toml

@@ -11,4 +11,4 @@ readme = "README.md"
 include = ["nvtx-sys/NVTX/c/*", "nvtx-sys/export.c", "src/*", "build.rs"]
 
 [build-dependencies]
-cc = "1.0.73"
+cc = "1.0"

README.md

@@ -1,6 +1,7 @@
 <img align="right" alt="NVIDIA Logo" width="25%" src="assets/Nvidia-Logo.png">
 
 # NVTX
+
 [![Crates.io](https://img.shields.io/crates/v/nvtx)](https://crates.io/crates/nvtx)
 [![Documentation](https://docs.rs/nvtx/badge.svg)](https://docs.rs/nvtx)
 [![Build Status](https://github.com/simbleau/nvtx/workflows/build/badge.svg)](https://github.com/simbleau/nvtx/actions/workflows/build.yml)
@@ -44,4 +45,5 @@ See the [changelog](CHANGELOG.md).
 ---
 
 ## 🔏 License
+
 This project is dual-licensed under both [Apache 2.0](LICENSE-APACHE) and [MIT](LICENSE-MIT) licenses.

src/lib.rs

@@ -1,11 +1,8 @@
 // This crate does not use the standard library
 #![no_std]
-#![feature(core_ffi_c)]
-#![feature(alloc_c_string)]
 // Enforce stricter documentation requirements
 #![warn(missing_docs)]
 #![warn(rustdoc::missing_crate_level_docs)]
-#![warn(rustdoc::missing_doc_code_examples)]
 #![warn(rustdoc::invalid_codeblock_attributes)]
 #![warn(rustdoc::broken_intra_doc_links)]
 

tests/thread_ranges.rs

@@ -4,12 +4,7 @@ use nvtx::{range_pop, range_push};
 fn test_thread_range() {
     let expected: i32 = range_push!("Test with {text}", text = "hi");
     let actual: i32 = range_pop!();
-    assert!(
-        expected == actual,
-        "Actual: {}, Expected: {}",
-        actual,
-        expected
-    );
+    assert_eq!(expected, actual);
 }
 
 #[test]
@@ -18,10 +13,5 @@ fn test_nested_range() {
     let expected = range_push!("Test with {text}", text = "hi");
     let actual: i32 = range_pop!();
     let _: i32 = range_pop!();
-    assert!(
-        expected == actual,
-        "Actual: {}, Expected: {}",
-        actual,
-        expected
-    );
+    assert_eq!(expected, actual);
 }