From a6b25681606a7994a79b5770426b547f09b6fb3a Mon Sep 17 00:00:00 2001 From: Gaute Hope Date: Sat, 7 Oct 2023 20:24:24 +0200 Subject: [PATCH] docs: point to new hdf5-rust fork with example patch section --- src/lib.rs | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 6234b14..eeede5a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -74,12 +74,18 @@ //! //! ## Fast indexing //! -//! The indexing can be sped up considerably (_about 200x_) by adding a new interface to iterating -//! over chunks in HDF5. The `fast-index` feature flag currently requires a patched version of -//! [hdf5-rust](https://github.com/gauteh/hdf5-rust/tree/hidefix) and -//! [hdf5](https://github.com/gauteh/hdf5/tree/chunk-iter-1-12). See this upstream -//! [pull-request](https://github.com/HDFGroup/hdf5/pull/6). You therefore have to use `patch` to -//! point the `hdf5` and `hdf5-sys` dependencies to the patched versions for now. +//! The indexing can be sped up considerably (_about 200x_) by using the new interface to [iterating +//! over chunks](https://github.com/HDFGroup/hdf5/pull/6) in HDF5. The `fast-index` feature flag currently requires a patched version of +//! [hdf5-rust](https://github.com/magnusuMET/hdf5-rust/tree/hidefix_jul_2023). You therefore have to use `patch` to +//! point the `hdf5` and `hdf5-sys` dependencies to the patched versions for now, in your +//! `Cargo.toml`: +//! +//! ```ignore +//! [patch.crates-io] +//! hdf5 = { git = "https://github.com/magnusuMET/hdf5-rust", branch = "hidefix_jul_2023" } +//! hdf5-sys = { git = "https://github.com/magnusuMET/hdf5-rust", branch = "hidefix_jul_2023" } +//! hdf5-src = { git = "https://github.com/magnusuMET/hdf5-rust", branch = "hidefix_jul_2023" } +//! ``` #![allow(incomplete_features)] #![recursion_limit = "1024"]