Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document semver stability of crate features #949

Merged
merged 2 commits into from
Feb 21, 2024
Merged

Document semver stability of crate features #949

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c51acd
Document semver stability of crate features
tgeoghegan Feb 16, 2024
4489a5e
review feedback
tgeoghegan Feb 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,13 @@ increases (e.g., 0.10 to 0.11).

This crate defines the following feature flags:

|Name|Default feature?|Description|
|---|---|---|
|`crypto-dependencies`|Yes|Enables dependencies on various RustCrypto crates, and uses them to implement `XofTurboShake128` to support VDAFs.|
|`experimental`|No|Certain experimental APIs are guarded by this feature. They may undergo breaking changes in future patch releases, as an exception to semantic versioning.|
|`multithreaded`|No|Enables certain Prio3 VDAF implementations that use `rayon` for parallelization of gadget evaluations.|
|Name|Default feature?|Description|Semver stable?|
|---|---|---|---|
|`crypto-dependencies`|Yes|Enables dependencies on various RustCrypto crates, and uses them to implement `XofTurboShake128` to support VDAFs.|✅|
|`experimental`|No|Certain experimental APIs are guarded by this feature.|❌|
|`multithreaded`|No|Enables certain Prio3 VDAF implementations that use `rayon` for parallelization of gadget evaluations.|✅|
|`test-util`|No|Enables test utilities like [the `dummy::Vdaf`][dummy-vdaf].|❌|
Copy link
Contributor

Choose a reason for hiding this comment

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

It might be worth mentioning prio::vdaf::test_utils::run_vdaf() as well, for testing VDAFs outside the crate. Or we could say more generically, "Enables test utilities for VDAF users and VDAF implementers."

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, best not to commit to enumerating test-util items. I switched to your suggested sentence.


Features that are not marked as "Semver stable" may undergo breaking changes in future patch releases, as an exception to semantic versioning.

[dummy-vdaf]: https://docs.rs/prio/latest/prio/vdaf/dummy/index.html