This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs-object-store.git
The following commit(s) were added to refs/heads/main by this push:
new c9db3e2 Clarify aws-lc-rs feature docs and fix CI comment URL (#764)
c9db3e2 is described below
commit c9db3e22d2eed690b7a9c14a988ec85d6b9304ad
Author: Andrew Lamb <[email protected]>
AuthorDate: Thu Jun 18 07:17:23 2026 -0400
Clarify aws-lc-rs feature docs and fix CI comment URL (#764)
* Clarify aws-lc-rs feature docs and fix CI comment URL
Follow-on documentation polish from the review of #707.
- Document that the `aws-lc-rs` feature requires the user to also select an
aws-lc-rs backend when the built-in `reqwest` transport is not enabled.
- Fix the malformed github.com URL in the CI testing-matrix comment.
Comment/documentation-only; no code or behavior changes.
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
* Update src/lib.rs
Co-authored-by: Kevin Liu <[email protected]>
* fmt
---------
Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
Co-authored-by: Kevin Liu <[email protected]>
---
.github/workflows/ci.yml | 2 +-
src/lib.rs | 6 ++++++
2 files changed, 7 insertions(+), 1 deletion(-)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 60be27e..7c232de 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -116,7 +116,7 @@ jobs:
run: cargo clippy --no-default-features --features http-base -- -D
warnings
# Testing matrix of HTTP and crypto providers
#
- # Improvements tracked in
https://githubcom/apache/arrow-rs-object-store/issues/759
+ # Improvements tracked in
https://github.com/apache/arrow-rs-object-store/issues/759
#
# Notes:
# Direct `reqwest` needs a TLS backend. Use `rustls-no-provider` so TLS
diff --git a/src/lib.rs b/src/lib.rs
index 115770d..b2d9a64 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -607,6 +607,12 @@
//! If you wish to use [`ring`] (e.g. to support WASM targets), use the
//! `*-base` feature flags, e.g. `aws-base`, and then enable the `ring`
feature.
//!
+//! When enabling the `aws-lc-rs` feature without the built-in `reqwest`
+//! transport (e.g. `aws-base` + `aws-lc-rs` with a custom [`HttpConnector`]),
+//! you must also select an [`aws-lc-rs`] backend, as `object_store` does not
+//! pick one for you.
+//! For example enable `aws-lc-rs/aws-lc-sys` (or `fips` / `non-fips`).
+//!
//! If both `ring` and `aws-lc-rs` are enabled, `aws-lc-rs` is used by default.
//!
//! You can also implement a custom [`client::CryptoProvider`] to use your own
cryptographic library.
