Paul Spooren
524ec68f3f
Add a docstring example for mio/uds_send_fd ( #563 )
2024-12-19 13:07:13 +01:00
Philipp Dresselmann
184603aa2c
chore: Add a missing cleanup step to the coverage script
...
Looks like `cargo llvm-cov` doesn't clean up the entire `target/llvm-cov-target` directory tree, which means running the coverage script more than once fails as `mv` refuses to overwrite the leftover doctest binaries from a previous run.
2024-12-19 12:36:32 +01:00
Philipp Dresselmann
ec6706ffeb
chore(docs): Add a docstring example for uds_send_fd
2024-12-19 11:42:46 +01:00
Paul Spooren
7571670e71
docs(wireguard-broker): add docs and examples ( #550 )
2024-12-19 09:51:51 +01:00
David Niehues
0d7dd99d96
test(wireguard-broker): Add smoketest and doc-tests for wiregaurd broker
2024-12-19 09:34:40 +01:00
David Niehues
c78a9cb777
docs(wireguard-broker): add docs and examples
2024-12-19 09:34:15 +01:00
Paul Spooren
dd0db53e8b
chore(doc): Docs for rosenpass::{config, cli} ( #560 )
2024-12-18 23:11:45 +01:00
Paul Spooren
422acf9891
Docs and unit tests for app_server.rs ( #552 )
2024-12-18 23:11:25 +01:00
Paul Spooren
877c15a018
chore(docs): minor typo fixes in app_server.rs
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-12-18 22:47:37 +01:00
Paul Spooren
55d7f8b1c1
Avoid unnecessarily copying the doctest binaries ( #558 )
2024-12-18 22:44:24 +01:00
Paul Spooren
199ff63a06
Add docstring examples and unit tests for the LengthPrefixEncoder module ( #500 )
2024-12-18 22:01:53 +01:00
Karolin Varner
47b556e317
chore(doc): Docs for rosenpass::{config, cli}
2024-12-18 20:48:12 +01:00
Philipp Dresselmann
f87e2cb31b
chore(doc): Fix module descriptions for length_prefix_encoding
...
There's a more complete module description for the encoder and decoder now. Both versions get appended by rustdoc, which looks wrong and shouldn't be necessary.
2024-12-18 16:24:50 +01:00
Philipp Dresselmann
58e1c8fbff
chore(coverage): Add unit tests for the LengthPrefixEncoder
...
There's some redundancy here with the docstring examples/tests, but that's entirely on purpose:
Unfortunately, it seems that the coverage tool has trouble recognizing calls from within the docstring examples. It's an unstable feature - maybe that's why?
Even with these tests, the tool still doesn't properly detect everything. Regardless, function coverage is 100% when running the coverage tool locally.
2024-12-18 16:24:50 +01:00
Philipp Dresselmann
c89c7d7acf
chore(doc): Add docstring examples for the LengthPrefixEncoder
2024-12-18 16:24:50 +01:00
Philipp Dresselmann
a5b876f119
chore(doc): Add a module summary for LengthPrefixEncoder
2024-12-18 16:23:13 +01:00
Philipp Dresselmann
c2f50f47b3
chore(doc): Update docstrings for LengthPrefixEncoder
...
This is more consistent with the LengthPrefixDecoder documentation.
2024-12-18 16:23:13 +01:00
Paul Spooren
53168dc62d
Add documentation, doc-tests and examples to the secret-memory crate. ( #531 )
2024-12-18 16:18:11 +01:00
David Niehues
2cfe703118
docu(secret-memeory): improve comment in example for Secret
2024-12-18 16:15:35 +01:00
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
50505d81cc
test: fix doctest in alloc/mod.rs to make it work on macos
2024-12-18 16:15:35 +01:00
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
d27e602f43
docu(doctest+coverage): add documentation, doc-tests and examples to the alloc module
2024-12-18 16:15:35 +01:00
Philipp Dresselmann
73f6b33dbb
chore: Avoid unnecessarily copying the doctest binaries
...
The doctest binaries can take up ~3GB for a debug build. There's no reason to waste that much disk space and copying them is slower than moving, too. They're only used by `grcov` right now, so they needn't be preserved.
2024-12-18 16:05:34 +01:00
Paul Spooren
a279dfc0b1
docs+doctest(to): Add tests, examples and documentation to the to-crate ( #546 )
2024-12-18 14:30:38 +01:00
Karolin Varner
caf2f6bfec
chore: Remove unused warning in api integration test
2024-12-18 14:28:51 +01:00
Karolin Varner
d398ad369e
fix: Disable asserts that rely on timing characteristics during coverage testing
2024-12-18 14:28:35 +01:00
Karolin Varner
00696321ff
chore: Final improvements on the to crate API doc
2024-12-18 14:28:24 +01:00
Paul Spooren
d807a1bca7
Add examples and docstring improvements for mio/uds_recv_fd ( #551 )
2024-12-18 12:29:20 +01:00
Karolin Varner
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
b394e302ab
chore(tests): start using unused test output ( #547 )
2024-12-18 11:22:38 +01:00
Paul Spooren
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
fc2f535eae
docs(util): add docs and examples for the remaining util crate ( #545 )
2024-12-18 11:16:00 +01:00
Paul Spooren
302e249f08
docs(constant-time): add docs, examples and safety notices ( #544 )
2024-12-18 10:58:35 +01:00
dependabot[bot]
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
Karolin Varner
35519e7baa
chore: Documentation and examples for app_server.rs
2024-12-17 18:18:27 +01:00
Karolin Varner
78af5d1dc4
chore: Mark CryptoServer::poll example as ignore
...
No need to run a test that is in tests/ also during the doctests
2024-12-17 18:14:55 +01:00
David Niehues
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
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
