Skip to content

Commit 5577bd7

Browse files
committed
Clarify reserved async feature docs
1 parent 7f79cdd commit 5577bd7

5 files changed

Lines changed: 12 additions & 9 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@
3535
feature-bundle check so NEON reserved-build evidence runs in automation.
3636
- Hardened release metadata validation to require the published crate package
3737
to include the SIMD admission policy and unsafe inventory documents.
38+
- Clarified 0.5 development documentation around benchmark claims and reserved
39+
`tokio` feature behavior.
3840
- Updated security documentation for streaming wrapper buffer cleanup behavior.
3941
- Updated release evidence documentation for stream fuzzing and reserved SIMD
4042
feature-bundle checks.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ license = "MIT OR Apache-2.0"
5858
| `std` | yes | `std::error::Error` support and feature base for I/O. |
5959
| `simd` | no | Future hardware acceleration. |
6060
| `stream` | no | `std::io` streaming wrappers. |
61-
| `tokio` | no | Future async streaming wrappers. |
62-
| `kani` | no | Future verifier harnesses. |
61+
| `tokio` | no | Reserved for future async streaming wrappers; currently adds no dependencies or APIs. |
62+
| `kani` | no | Reserved for verifier harnesses; normal builds do not require Kani. |
6363
| `fuzzing` | no | Reserved for verifier and fuzz harness integration; published crate stays dependency-free. |
6464

6565
Disable defaults for embedded or freestanding use:

docs/BENCHMARKS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ decode lookup table. That keeps the default implementation aligned with the
3838
side-channel hardening roadmap, but it is expected to trail highly optimized
3939
table-based decoders on large buffers.
4040

41-
Treat scalar decode throughput as an optimization target for `0.4.1`, not as a
42-
release claim. Any future fast scalar or SIMD path must preserve strict error
43-
indexes, canonical padding rejection, Miri cleanliness, and scalar/SIMD
44-
differential test evidence.
41+
Treat scalar decode throughput as an optimization target for the current
42+
development cycle, not as a release claim. Any future fast scalar or SIMD path
43+
must preserve strict error indexes, canonical padding rejection, Miri
44+
cleanliness, and scalar/SIMD differential test evidence.

docs/MIGRATION.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,8 @@ let encoded = encoder.finish().unwrap();
166166
assert_eq!(encoded, b"aGVsbG8=");
167167
```
168168

169-
Tokio wrappers are planned but are not part of `0.4.1`.
169+
The `tokio` feature is reserved for future async wrappers. It currently adds
170+
no dependencies or APIs.
170171

171172
## Security Notes
172173

docs/PLAN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ Any dependency addition must answer:
8181
- Chunk-boundary state machines.
8282

8383
5. `tokio`
84-
- Future async wrappers.
85-
- Explicit optional dependency.
84+
- Reserved feature for future async wrappers.
85+
- Explicit optional dependency only if the async API is admitted.
8686

8787
### API Policy
8888

0 commit comments

Comments
 (0)