Skip to content

docs: correct opt-in build notes for kafka and mithril#945

Merged
scarmuega merged 1 commit into
mainfrom
docs/accurate-optin-build-notes
Jun 15, 2026
Merged

docs: correct opt-in build notes for kafka and mithril#945
scarmuega merged 1 commit into
mainfrom
docs/accurate-optin-build-notes

Conversation

@scarmuega

@scarmuega scarmuega commented Jun 15, 2026

Copy link
Copy Markdown
Member

Follow-up to #944 fixing two inaccurate notes about the opt-in (source-build) integrations. Docs/comments only — no behaviour change.

  • mithrilSlim dependencies and ship a batteries-included default binary #944 said it's "unsupported on Windows MSVC". The green cargo check --all-features Windows CI check disproves that: mithril's GMP/blst C-crypto crates build and statically link on windows-msvc. It's opt-in because it's a heavy C toolchain (larger binary, much longer build), not for portability.
  • kafka — now that the kafka feature pulls a vendored OpenSSL build, opt-in builds need a C compiler + Perl, not the platform's system OpenSSL dev libraries.
  • Also reworded the zeromq note to make the real reason explicit: it dynamically links a system libzmq at runtime, so it can't ship in a portable prebuilt binary.

Touches the [package.metadata.dist] comment in Cargo.toml and the two installation docs.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified which integrations (Kafka, ZeroMQ, Mithril) are excluded from portable binary releases and their system/C dependency constraints.
    • Updated build prerequisites documentation with improved explanations of required toolchains and dependencies for building from source.

The batteries-included PR (#944) described mithril as "unsupported on
Windows MSVC", but the green `--all-features` Windows CI check shows its
GMP/blst C-crypto crates build and statically link there. Mithril is opt-in
because it's a heavy C toolchain (large binary + long build), not for
portability reasons.

Also fix the kafka note: it now pulls a vendored OpenSSL build (wired to the
`kafka` feature), so opt-in builds need a C compiler + Perl rather than the
platform's system OpenSSL dev libraries. No behaviour change.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@scarmuega scarmuega requested a review from paulobressan as a code owner June 15, 2026 00:20
@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c12d7838-5a06-4677-a926-2b615db46ea3

📥 Commits

Reviewing files that changed from the base of the PR and between fa0a3b6 and 57837e3.

📒 Files selected for processing (3)
  • Cargo.toml
  • docs/v2/installation/binary_release.mdx
  • docs/v2/installation/from_source.mdx

📝 Walkthrough

Walkthrough

Comments in Cargo.toml and two installation documentation files (binary_release.mdx, from_source.mdx) are updated to clarify why kafka, zeromq, and mithril are excluded from the default portable binary, citing OpenSSL/C compiler requirements, dynamic libzmq linking, and the heavy GMP/blst crypto toolchain respectively. No code, dependency versions, or feature lists are changed.

Changes

Feature exclusion rationale clarification

Layer / File(s) Summary
Feature exclusion comments and installation docs
Cargo.toml, docs/v2/installation/binary_release.mdx, docs/v2/installation/from_source.mdx
Comment block in Cargo.toml reworded to "kept OUT (available via a source build) to keep the release lean and free of system/C dependencies." binary_release.mdx rewrites per-integration exclusion reasons. from_source.mdx updates the prerequisites table (kafka → vendored OpenSSL + C compiler + Perl; mithril → heavy GMP/blst C-crypto toolchain, slow builds) and the --all-features note to mention system libzmq and the mithril C-crypto toolchain.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • paulobressan

Poem

🐇 Hop hop, the comments are clear,
No C deps shall cause the binary fear!
kafka, zeromq, mithril aside,
In source builds only they shall reside.
The lean release hops free with pride! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: correcting documentation for opt-in build notes for kafka and mithril.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/accurate-optin-build-notes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@scarmuega scarmuega merged commit 439c4db into main Jun 15, 2026
11 of 12 checks passed
@scarmuega scarmuega deleted the docs/accurate-optin-build-notes branch June 15, 2026 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant