eclipse-iceoryx / iceoryx2

Eclipse iceoryx2™ - true zero-copy inter-process-communication in pure Rust
https://iceoryx.io
Apache License 2.0
1.03k stars 40 forks source link

Use feature instead of exporting the crate for testing with hidden doc #476

Open xieyuschen opened 1 month ago

xieyuschen commented 1 month ago

Currently, iceoryx exposes an API for testing purpose and hides its docs. I think a more reasonable approach is define a feature called iox2-test for it so we can ensure it won't be involved inside users code except the explicit feature setting up. A testing feature is needed because the default test doesn't support cross package usage.

https://github.com/eclipse-iceoryx/iceoryx2/blob/558c727395f50793f4e341dae73dd7315c4f6a4f/iceoryx2-bb/elementary/src/bump_allocator.rs#L17-L20