Skip to content

Commit

Permalink
Document semver stability of crate features (#949)
Browse files Browse the repository at this point in the history
Adds a column to the table in "Cargo features" documenting whether items
gated behind each feature are exempt from Semver stability guarantees.
  • Loading branch information
tgeoghegan committed Feb 21, 2024
1 parent 2b00f1c commit d7c1c08
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,11 @@ 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 for VDAF users and VDAF implementers.||

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

0 comments on commit d7c1c08

Please sign in to comment.