Squashed commit of the following:

commit b4a144c Author: Brandon Saint-John <[email protected]> Date: Mon Mar 11 00:14:01 2024 -0700 New and cleaner CHANGELOG commit 9c55cad Author: Brandon Saint-John <[email protected]> Date: Mon Mar 11 00:06:11 2024 -0700 slow5lib-sys: Fix typos in README commit 07c6249 Author: Brandon Saint-John <[email protected]> Date: Mon Mar 11 00:03:25 2024 -0700 bump slow5lib_sys minor version: added new item commit b805b8b Author: Brandon Saint-John (aarch64) <[email protected]> Date: Fri Mar 8 15:25:10 2024 -0800 Expand testing os commit f5c9a5d Author: Brandon Saint-John <[email protected]> Date: Thu Feb 29 08:26:41 2024 -0800 fix: README.md cleanup commit a165655 Author: Brandon Saint-John <[email protected]> Date: Wed Feb 28 21:12:52 2024 -0800 bug: forgot to switch back CargoCallbacks commit 177f60a Author: Brandon Saint-John <[email protected]> Date: Wed Feb 28 21:02:19 2024 -0800 fix: missing __gnuc_va_list breaks compilation This commit adds __gnuc_va_list as a public type into slow5lib-sys. I recently ran into compilation errors during the build.rs phase of slow5lib-sys, 71 | pub type va_list = __gnuc_va_list; | ^^^^^^^^^^^^^^ not found in this scope It isn't clear why previous iterations didn't encounter this issue, and possibly may be due to compiler versions. There have been some issues dealing with variadic arguments. The only function using this is slow5_vasprintf, and in the future it might make more sense to remove that function from the API. But for now, we will add the missing type.
bsaintjo · Mar 11, 2024 · f0260e0 · f0260e0
1 parent d700e73
commit f0260e0
Show file tree

Hide file tree

Showing 7 changed files with 51 additions and 17 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -19,10 +19,11 @@ env:
 jobs:
   build:
 
-    runs-on: ubuntu-latest
     strategy:
       matrix:
+        os: [ubuntu-latest, ubuntu-20.04, macos-14]
         features: [--all-features, --no-default-features]
+    runs-on: ${{ matrix.os }}
 
     steps:
     - uses: actions/checkout@v3

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased] - yyyy-mm-dd
+<!-- ## [Unreleased] - yyyy-mm-dd
 
 ### Added
 
@@ -15,7 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
-### Fixed
+### Fixed -->
 
 ## [0.11.0]
 

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![Crates.io][crates-badge]][crates-url]
 [![docs.rs][docs-badge]][docs-url]
 [![Rust][ci-badge]][ci-url]
-![Stability][stability-badge]
+[![stable][stability-badge]][stability-url]
 [![codecov][codecov-badge]][codecov-url]
 
 [license-badge]: https://img.shields.io/crates/l/slow5?style=flat-square
@@ -17,13 +17,18 @@
 [ci-url]: https://github.com/bsaintjo/slow5-rs/actions/workflows/rust.yml
 [codecov-badge]: https://codecov.io/gh/bsaintjo/slow5-rs/branch/main/graph/badge.svg?token=MODXRVRNQ0
 [codecov-url]: https://codecov.io/gh/bsaintjo/slow5-rs
-[stability-badge]: https://img.shields.io/badge/stability-experimental-orange.svg
+[stability-badge]: http://badges.github.io/stability-badges/dist/stable.svg
+[stability-url]: http://github.com/badges/stability-badges
+A library for interacting with SLOW5/BLOW5 files in the Rust programming language.
 
-A library for interacting with SLOW5/BLOW5 files in rust. Not official.
+For more information check out the main [slow5lib repository](https://github.com/hasindu2008/slow5lib) or the [paper](https://doi.org/10.1038/s41587-021-01147-4).
 
-For more information checkout the main [slow5lib repository](https://github.com/hasindu2008/slow5lib).
+This repository provides two crates:
 
-*Note*: Library design is in flux and care should be taken in upgrading this crate.
+- `slow5lib-sys`: Bindings to the C library using `bindgen`
+- `slow5`: Rust API built on-top of `slow5lib-sys`
+
+The interface for `slow5` is largely stable and now updated primarily to follow new versions `slow5lib`. If there is additional functionality you'd like to see, please file a Github Issue.
 
 ## Installation
 
@@ -94,16 +99,19 @@ For more example code, see the [test code](tests/full.rs). Several examples from
 
 ## Feature flags
 
-* `zstd`:       Enable zstd-based compression (enabled by default)
-* `zlib-ng`:    Enable usage of high performance zlib-ng, adds `cmake` dependency
-* `serde`:      Enable `serde` dependency (mainly for serializing `Record`)
+- `zstd`:       Enable zstd-based compression
+  - enabled by default
+- `zlib-ng`:    Enable usage of high performance zlib-ng
+  - adds `cmake` dependency
+- `serde`:      Enable `serde` dependency
+  - Mainly for serializing `Record` into `serde`-compatible formats
 
 ## License
 
 Licensed under either of
 
-* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
-* MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
 
 at your option.
 

diff --git a/slow5lib-sys/CHANGELOG.md b/slow5lib-sys/CHANGELOG.md
@@ -0,0 +1,24 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!-- ## [Unreleased] - yyyy-mm-dd
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed -->
+
+## [0.9.1] - 2024-03-11
+
+### Added
+
+- Add `__gnuc_va_list` type to fix compilation errors
diff --git a/slow5lib-sys/Cargo.toml b/slow5lib-sys/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "slow5lib-sys"
-version = "0.9.0+slow5lib.1.1.0"
+version = "0.9.1+slow5lib.1.1.0"
 readme = "README.md"
 homepage = "https://github.com/hasindu2008/slow5lib"
 description = "Low-level bindings to the slow5lib C library"

diff --git a/slow5lib-sys/README.md b/slow5lib-sys/README.md
@@ -11,7 +11,7 @@
 [docs-badge]: https://img.shields.io/docsrs/slow5lib-sys?style=flat-square
 [docs-url]: https://docs.rs/slow5lib-sys
 
-Low level bindings to the `slow5lib` C library version 1.0.0
+Low level bindings to the `slow5lib` C library version 1.1.0
 
 ## Installation
 
@@ -26,8 +26,8 @@ slow5lib-sys = "0.9"
 
 Licensed under either of
 
-- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
+- Apache License, Version 2.0, ([LICENSE-APACHE](../LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT](../LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
 
 at your option.
 

diff --git a/slow5lib-sys/build.rs b/slow5lib-sys/build.rs
@@ -79,6 +79,7 @@ fn main() -> Result<(), Box<dyn Error>> {
         .allowlist_type("slow5_.*")
         .allowlist_type("__slow5_press")
         .allowlist_type("__va_list_tag")
+        .allowlist_type("__gnuc_va_list")
         .allowlist_type("va_list")
         .allowlist_type("__darwin_va_list")
         .allowlist_type("__builtin_va_list")