David Niehues
a2d7c3aaa6
chore(secret-memory): fix typos
2024-12-18 16:15:35 +01:00
David Niehues
1aa111570e
style(secret-memory): improve style in doc-tests around using the the ?-operator
2024-12-18 16:15:35 +01:00
David Niehues
a91d61f9f0
docs(secret-memory): fix warnings when generating the documentation
2024-12-18 16:15:35 +01:00
David Niehues
ff7827c24e
test(fix-doctest): fix doctests where a function si wrapped around a doctest but the function is never called
2024-12-18 16:15:35 +01:00
David Niehues
255e377d29
test(coverage): add unit tests to improve coverage in public.rs and secret.rs
2024-12-18 16:15:35 +01:00
David Niehues and David Niehues
50505d81cc
test: fix doctest in alloc/mod.rs to make it work on macos
2024-12-18 16:15:35 +01:00
David Niehues and David Niehues
10484cc6d4
docs(doctests+coverage): add documentation and doctests for all modules of secret-memory except for alloc
2024-12-18 16:15:35 +01:00
David Niehues and David Niehues
d27e602f43
docu(doctest+coverage): add documentation, doc-tests and examples to the alloc module
2024-12-18 16:15:35 +01:00
Paul Spooren and GitHub
a279dfc0b1
docs+doctest(to): Add tests, examples and documentation to the to-crate ( #546 )
2024-12-18 14:30:38 +01:00
Karolin Varner and David Niehues
caf2f6bfec
chore: Remove unused warning in api integration test
2024-12-18 14:28:51 +01:00
Karolin Varner and David Niehues
d398ad369e
fix: Disable asserts that rely on timing characteristics during coverage testing
2024-12-18 14:28:35 +01:00
Karolin Varner and David Niehues
00696321ff
chore: Final improvements on the to crate API doc
2024-12-18 14:28:24 +01:00
Paul Spooren and GitHub
d807a1bca7
Add examples and docstring improvements for mio/uds_recv_fd ( #551 )
2024-12-18 12:29:20 +01:00
Karolin Varner and GitHub
4daf97b2ee
style(ciphers): improve style in doc-tests around using the the ?-operator in the ciphers crate ( #549 )
2024-12-18 11:23:59 +01:00
Karolin Varner and GitHub
b394e302ab
chore(tests): start using unused test output ( #547 )
2024-12-18 11:22:38 +01:00
Paul Spooren and Karolin Varner
198bc2d5f2
chore(tests): start using unused test output
...
Resolve a warning of unused `output` variable.
Fixes: 0745019mail@aparcar.org >
2024-12-18 11:22:16 +01:00
Paul Spooren and GitHub
fc2f535eae
docs(util): add docs and examples for the remaining util crate ( #545 )
2024-12-18 11:16:00 +01:00
Paul Spooren and GitHub
302e249f08
docs(constant-time): add docs, examples and safety notices ( #544 )
2024-12-18 10:58:35 +01:00
dependabot[bot] and Paul Spooren
d8fe3eba5f
build(deps): bump clap_complete from 4.5.38 to 4.5.40
...
Bumps [clap_complete](https://github.com/clap-rs/clap ) from 4.5.38 to 4.5.40.
- [Release notes](https://github.com/clap-rs/clap/releases )
- [Changelog](https://github.com/clap-rs/clap/blob/master/CHANGELOG.md )
- [Commits](https://github.com/clap-rs/clap/compare/clap_complete-v4.5.38...clap_complete-v4.5.40 )
---
updated-dependencies:
- dependency-name: clap_complete
dependency-type: direct:production
update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com >
2024-12-18 10:29:44 +01:00
David Niehues and Amin Faez
61b8b28e86
style(ciphers): improve style in doc-tests around using the the ?-operator in the ciphers crate
2024-12-17 11:57:54 +01:00
Amin Faez
26f77924f8
docs(constant-time): add docs, examples and safety notices
2024-12-17 11:56:33 +01:00
Amin Faez
2e0e2cfa0c
docs(util): add docs and examples for the remaining util crate
2024-12-17 11:55:23 +01:00
Karolin Varner and GitHub
9cc860fdeb
Fix doctests where Function is wrapped around the actual test but is never called in cipher traits ( #542 )
2024-12-16 23:30:34 +01:00
Philipp Dresselmann
a537eb3e1b
chore(docs): Adjust docstrings for the mio module
2024-12-16 22:29:01 +01:00
Philipp Dresselmann
ea233bf137
chore(docs): Add an example for the UnixListenerExt trait
2024-12-16 22:28:53 +01:00
Philipp Dresselmann
db8796ab40
chore(docs): Add an example for the uds_recv_fd module
2024-12-16 20:54:08 +01:00
David Niehues
0353c82729
docs+doctest(to): Add tests, examples and documentation to the to-crate
2024-12-16 17:47:44 +01:00
David Niehues
ae3fbde0a3
test(fix-doctest): fix doctests where a function is wrapped around a doctest but the function is never called
...
In the doctests in kem.rs, the actual tests that are run to verify that the KyberKem and the DummyKem actually work
are wrapped inside a function to make use of the ?-operator. However, these functions were never called and thus
the tests weren't really helpful and didn't provide proper coverage.
2024-12-16 17:05:41 +01:00
Philipp Dresselmann
51d4dede15
chore(doc): Add a link to the MIO utils module summary
2024-12-16 17:02:43 +01:00
Karolin Varner
4725a2d628
Merge: fix most broken doc-links (ciphers & cipher-traits) ( #543 )
2024-12-16 16:34:14 +01:00
David Niehues and Karolin Varner
a6bac74d48
docs(ciphers+cipher-traits):fix most broken doc-links in the ciphers and cipher-traits crates.
...
Some links in the documentation of the ciphers and cipher-traits were broken or linked to private fields.
This PR fixes most of these occasions and some more warnings in cargo doc.
The reaming issues are links to chacha20poly1305_ietf, that are broken because the feature experiment_libcrux corresponding feature is enabled. Analogously, disabling the feature would lead to broken links to chacha20poly1305_ietf_libcrux.
2024-12-16 16:33:18 +01:00
Karolin Varner and GitHub
b9a34f4238
protocol.rs docs and unit tests ( #537 )
2024-12-16 16:31:33 +01:00
Karolin Varner and Paul Spooren
46e855b266
chore(doc): Documentation, examples & tests for protocol.rs
...
Co-authored-by: Paul Spooren <mail@aparcar.org >
2024-12-16 16:31:22 +01:00
Karolin Varner
c0b91fd729
fix: Reinstate blanket error handling in event loop
...
Fixes #534
2024-12-16 16:31:22 +01:00
Karolin Varner and GitHub
97dff8453d
Fix grcov reports not including doctest and branch coverage ( #548 )
2024-12-16 16:30:55 +01:00
Philipp Dresselmann
a3d4686104
chore(coverage): Fix doctest coverage in the grcov reports
...
The binary path doesn't contain any doctest executables (i.e., rust_out).
Coverage reports then don't include doctests, presumably because grcov can't map the profdata references to its respective doctest binary.
2024-12-16 15:13:07 +01:00
Philipp Dresselmann
cee0678817
chore(coverage): Fix llvm-cov branch coverage metrics
...
Without this flag, the generated reports show 0% branch coverage.
2024-12-16 15:13:07 +01:00
Paul Spooren and GitHub
a996f194c7
docs(util): add docs and examples to the zerocopy module ( #532 )
2024-12-16 11:25:24 +01:00
Paul Spooren and GitHub
447be89414
docs(util): fix doc reference in decoder.rs ( #538 )
2024-12-16 09:59:58 +01:00
Amin Faez
ef4f550abc
docs(util): fix doc reference in the zerocopy module
2024-12-15 13:05:55 +01:00
Amin Faez
4737cd2b2a
docs(util): fix doc reference in decoder.rs
...
docs(util): add more tests and example to complete coverage
2024-12-15 12:48:47 +01:00
Amin Faez
9336794e4d
docs(util): add docs and examples to the zerocopy module
2024-12-14 03:00:27 +01:00
Paul Spooren and GitHub
096bac6ee5
Add documentation for the rp crate ( #528 )
2024-12-13 12:35:19 +01:00
Karolin Varner and GitHub
161826979a
build(deps): bump serde from 1.0.215 to 1.0.216 ( #530 )
2024-12-13 10:25:20 +01:00
dependabot[bot] and GitHub
c435b772d2
build(deps): bump serde from 1.0.215 to 1.0.216
...
Bumps [serde](https://github.com/serde-rs/serde ) from 1.0.215 to 1.0.216.
- [Release notes](https://github.com/serde-rs/serde/releases )
- [Commits](https://github.com/serde-rs/serde/compare/v1.0.215...v1.0.216 )
---
updated-dependencies:
- dependency-name: serde
dependency-type: direct:production
update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com >
2024-12-12 23:45:16 +00:00
David Niehues
8805ef7c38
style: Ensure inline comments start upper case and end with a dot, and fix some overlong lines.
2024-12-12 21:14:02 +01:00
David Niehues
cca02dc8d1
add documentation for the rp crate
2024-12-12 21:14:02 +01:00
Karolin Varner and GitHub
d4350195eb
build(deps): bump rustix from 0.38.41 to 0.38.42 ( #524 )
2024-12-12 18:13:23 +01:00
dependabot[bot] and Karolin Varner
1c5e4ecf95
build(deps): bump rustix from 0.38.41 to 0.38.42
...
Bumps [rustix](https://github.com/bytecodealliance/rustix ) from 0.38.41 to 0.38.42.
- [Release notes](https://github.com/bytecodealliance/rustix/releases )
- [Changelog](https://github.com/bytecodealliance/rustix/blob/main/CHANGELOG.md )
- [Commits](https://github.com/bytecodealliance/rustix/compare/v0.38.41...v0.38.42 )
---
updated-dependencies:
- dependency-name: rustix
dependency-type: direct:production
update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com >
2024-12-12 18:12:41 +01:00
Karolin Varner and GitHub
b15947b815
Add doc-tests to the cipher-traits crate ( #529 )
2024-12-12 18:08:00 +01:00
David Niehues