docs: crate READMEs describe each crate as it is today
Every crate under crates/ now has a README (android, bench, cli, napi and wasm had none), each saying what the crate is, its main types and functions (names checked against the code), its cargo features with defaults and which ones build C (checked with `cargo tree`), and links to the top-level docs. Corrections to the old stubs: - clawhdf5-derive: the derive is `H5Type`, not `HDF5Type`, and it needs clawhdf5-format as a dependency. - clawhdf5-filters: deflate backends only, and no library crate depends on it; the filter pipeline and every other codec are in -format. - clawhdf5-gpu: vector distance compute, not I/O; not used by HDF5Memory::search. - clawhdf5-io: MpiVol is root-read + broadcast, not collective MPI-IO. - clawhdf5-ann: from_hdf5/search(q, k) did not exist; load_from_hdf5 and search(q, k, ef). - clawhdf5-accel: checksum::crc32_simd did not exist; the SSE4 and wasm backends are reported but run the scalar kernels. - clawhdf5-gpu: the old example called l2_distances, which does not exist (l2_search). - clawhdf5-agent: it described a "vector store" with "GPU acceleration"; it now covers HDF5Memory, search options, WAL, signing, the graph. - crates.io/docs.rs badges removed and `cargo install <crate>` replaced: nothing is published; depend on git. - fuzz: the opt-in CLAWHDF5_FUZZ_SECONDS smoke run in ci-test.sh. - tools: the FileEditor interop tests that live in this crate. - remote, py: license, other front ends, limits, File.mode/flush/chunks. The Rust examples of the facade, format, filters, accel, ann, derive and agent READMEs were compiled and run as tests (netcdf4, gpu and remote compiled only) in a scratch crate; the CLI example was run. Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
This commit is contained in:
@@ -51,10 +51,18 @@ done
|
||||
|
||||
## CI
|
||||
|
||||
These targets are **not** run in CI (`.gitea/workflows/ci.yml`) — cargo-fuzz
|
||||
requires nightly and each meaningful run takes minutes, which doesn't fit a
|
||||
per-PR gate. Run them manually on a schedule (e.g. before a release, or after
|
||||
touching parser code) instead.
|
||||
These targets are **not** run by the CI workflows (`.gitea/workflows/ci.yml`)
|
||||
— cargo-fuzz requires nightly and each meaningful run takes minutes, which
|
||||
doesn't fit a per-PR gate. Run them by hand before a release or after
|
||||
touching parser code. `scripts/ci-test.sh` has an opt-in smoke run: with
|
||||
`CLAWHDF5_FUZZ_SECONDS=N` it runs every target of this crate and of
|
||||
`crates/clawhdf5-agent/fuzz` (the WAL parser) for N seconds each.
|
||||
|
||||
Other robustness checks that do run: the nightly conformance sweep reads
|
||||
the HDF Group's CVE reproducers and fails on any panic, hang, crash or
|
||||
out-of-memory ([`conformance/README.md`](../../../conformance/README.md)),
|
||||
and `scripts/h5rs-fuzz.sh` runs every `h5rs` subcommand over them, optionally
|
||||
on byte-flipped copies.
|
||||
|
||||
## Reproducing Crashes
|
||||
|
||||
|
||||
Reference in New Issue
Block a user