Skip to content

docs: clarify SIMD build requirements - #148

Merged
brndnmtthws merged 3 commits into
mainfrom
brndnmtthws/docs-simd-rustflags
Jul 16, 2026
Merged

docs: clarify SIMD build requirements#148
brndnmtthws merged 3 commits into
mainfrom
brndnmtthws/docs-simd-rustflags

Conversation

@brndnmtthws

Copy link
Copy Markdown
Owner

Summary

Clarify that dryoc's portable SIMD backends require the simd_backend and nightly features, but do not require target-specific RUSTFLAGS.

User Impact

Users no longer receive unnecessary CPU-specific compiler flag recipes when enabling portable SIMD. Dependency-provided SIMD backends continue to select supported implementations independently.

Root Cause

The documentation retained older compile-time backend guidance after dryoc moved its SIMD implementations to portable SIMD and dependencies adopted their own backend selection.

Fix

  • Replace the target-specific RUSTFLAGS list with explicit no-flags guidance.
  • Remove the inaccurate build-time qualifier from the curve25519-dalek backend description.
  • Keep the README and crate-level rustdoc synchronized.

Validation

  • env -u RUSTFLAGS -u CARGO_ENCODED_RUSTFLAGS cargo +nightly test --features simd_backend,nightly
  • RUSTDOCFLAGS='-D warnings' env -u RUSTFLAGS -u CARGO_ENCODED_RUSTFLAGS cargo +nightly doc --no-deps --features serde,wincode,nightly,simd_backend
  • cargo +nightly fmt --all -- --check

@netlify

netlify Bot commented Jul 16, 2026

Copy link
Copy Markdown

Deploy Preview for dryoc-docs ready!

Name Link
🔨 Latest commit 95d6354
🔍 Latest deploy log https://app.netlify.com/projects/dryoc-docs/deploys/6a58cbdb5988a00007d8d5fe
😎 Deploy Preview https://deploy-preview-148--dryoc-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@brndnmtthws
brndnmtthws marked this pull request as ready for review July 16, 2026 12:13
Copilot AI review requested due to automatic review settings July 16, 2026 12:13

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@codecov

codecov Bot commented Jul 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.44%. Comparing base (dd9e59b) to head (95d6354).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #148      +/-   ##
==========================================
- Coverage   82.49%   82.44%   -0.05%     
==========================================
  Files          58       58              
  Lines        4427     4427              
==========================================
- Hits         3652     3650       -2     
- Misses        775      777       +2     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@brndnmtthws
brndnmtthws merged commit a1c605e into main Jul 16, 2026
34 of 35 checks passed
@brndnmtthws
brndnmtthws deleted the brndnmtthws/docs-simd-rustflags branch July 16, 2026 12:26
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.

2 participants