Merge pull request #9 from blas-lapack-rs/jed/blis-src-0.2.1

blis-src 0.2.1

Author: jedbrown

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "source"]
 	path = blis-src/upstream
-	url = https://github.com/jedbrown/blis
+	url = https://github.com/flame/blis

README.md

@@ -4,7 +4,7 @@ This repository contains a Rust package to build and link [BLIS], the BLAS-like
 
  ```toml
 [dependencies]
-blas-src = { version = "0.7", features = ["blis"] }
+blas-src = { version = "0.8", features = ["blis"] }
 ```
 
 To access the full BLIS API, direct use of `extern "C"` is necessary at this time.

blis-src/Cargo.toml

@@ -5,14 +5,12 @@ authors = [
 ]
 name = "blis-src"
 edition = "2018"
-version = "0.2.1-alpha.0"
-license = "MIT/Apache-2.0"
+version = "0.2.1"
+license = "MIT OR Apache-2.0"
 description = "Rust native linking for BLIS library"
 repository = "https://github.com/blas-lapack-rs/blis-src"
 keywords = [ "blas", "blis" ]
 categories = [ "science" ]
-documentation = "http://docs.rs/blis-src"
-readme = "../README.md"
 links = "blis"
 exclude = [
     "upstream/docs/",

blis-src/README.md

@@ -1,14 +1,25 @@
-# Blis-sys
+# blis-src
 
-This crate provides BLAS and/or CBLAS function using [BLIS](https://github.com/flame/blis).
+This crate provides BLAS and/or CBLAS functions using [BLIS](https://github.com/flame/blis).
 
-Features:
+## Features:
 
-* `cblas`: includes cblas binding (on by default)
+* `cblas`: build the CBLAS interface (enabled by default)
 * `static`: prefer static link (be very careful with this one on Apple platforms)
-* `system`: do not compile blis, link it from a system-wide installation instead
+* `pthreads` or `openmp` or `serial`: choose exactly one to specify the threading mode (`pthreads` by default)
+* `system`: do not compile BLIS and instead use a system-provided version (must be in system's default link path).
 
-It does not provides the BLAS or CBLAS functions Rust declarations. It is meant
-to use the ones provides by `blas-sys` and `cblas-sys` crates instead.
+This package does not provides Rust declarations for BLAS or CBLAS, which
+are available in the [`blas-sys`](https://lib.rs/crates/blas-sys) and
+[`cblas-sys`](https://lib.rs/crates/cblas-sys) crates. See the [blas
+example](https://github.com/blas-lapack-rs/blis-src/blob/main/blis-src/tests/blas_gemm.rs) and [cblas example](https://github.com/blas-lapack-rs/blis-src/blob/main/blis-src/tests/cblas_gemm.rs)
+for usage.
 
-See also [blas example](tests/blas_gemm.rs) or [cblas example](tests/cblas_gemm.rs).
+Users simply seeking a fast BLAS are encouraged to use
+[`blas-sys`](https://lib.rs/crates/blas-src) with the following in
+`Cargo.toml`:
+
+```toml
+[dependencies]
+blas-src = { version = "0.8", features = ["blis"] }
+```

blis-src/src/lib.rs

@@ -1,28 +1,4 @@
-//! # blis-src
-//!
-//! This crate provides BLAS and/or CBLAS function using [BLIS](https://github.com/flame/blis).
-//!
-//! Features:
-//!
-//! * `cblas`: build the CBLAS interface (enabled by default)
-//! * `static`: prefer static link (be very careful with this one on Apple platforms)
-//! * `pthreads` or `openmp` or `serial`: choose exactly one to specify the threading mode (`pthreads` by default)
-//! * `system`: do not compile BLIS and instead use a system-provided version (must be in system's default link path).
-//!
-//! This package does not provides Rust declarations for BLAS or CBLAS, which
-//! are available in the [`blas-sys`](https://lib.rs/crates/blas-sys) and
-//! [`cblas-sys`](https://lib.rs/crates/cblas-sys) crates. See the [blas
-//! example](../tests/blas_gemm.rs) and [cblas example](../tests/cblas_gemm.rs)
-//! for usage.
-//!
-//! Users simply seeking a fast BLAS are encouraged to use
-//! [`blas-sys`](https://lib.rs/crates/blas-src) with the following in
-//! `Cargo.toml`:
-//!
-//! ```toml
-//! [dependencies]
-//! blas-src = { version = "0.7", features = ["blis"] }
-//! ```
+#![doc = include_str!("../README.md")]
 
 #[cfg(test)]
 mod tests {

blis-src/tests/blas_gemm.rs

@@ -1,3 +1,5 @@
+//! Test calling Fortran `sgemm` using `blas-sys`.
+
 extern crate blas_sys;
 extern crate blis_src;
 

blis-src/tests/cblas_gemm.rs

@@ -1,3 +1,5 @@
+//! Test calling `cblas_sgemm` using `cblas-sys`.
+
 extern crate blis_src;
 extern crate cblas_sys;