search

eclipse-iceoryx / iceoryx2

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

[#4] prepare documentation for release #189

Closed elfenpiff closed 2 months ago

elfenpiff commented 2 months ago

Notes for Reviewer

Pre-Review Checklist for the PR Author

  1. [x] Add sensible notes for the reviewer
  2. [x] PR title is short, expressive and meaningful
  3. [x] Relevant issues are linked in the References section
  4. [x] Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
  5. [x] Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  6. [x] Commits messages are according to this guideline
    • [x] Commit messages have the issue ID ([#123] Add posix ipc example)
    • [x] Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  7. [x] Tests follow the best practice for testing
  8. [x] Changelog updated in the unreleased section including API breaking changes
  9. [x] Assign PR to reviewer
  10. [x] All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

Post-review Checklist for the PR Author

  1. [x] All open points are addressed and tracked via issues

References

Relates to #4

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 81.08108% with 28 lines in your changes are missing coverage. Please review.

Project coverage is 78.56%. Comparing base (b0a28c6) to head (ea11d0b).

:exclamation: Current head ea11d0b differs from pull request most recent head aee0283. Consider uploading reports for the commit aee0283 to get more accurate results

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189/graphs/tree.svg?width=650&height=150&src=pr&token=FN3YFXTJCI&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx)](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx) ```diff @@ Coverage Diff @@ ## main #189 +/- ## ========================================== - Coverage 78.64% 78.56% -0.08% ========================================== Files 181 181 Lines 19922 19933 +11 ========================================== - Hits 15667 15660 -7 - Misses 4255 4273 +18 ``` | [Files](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx) | Coverage Δ | | |---|---|---| | [iceoryx2-bb/container/src/byte\_string.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?src=pr&el=tree&filepath=iceoryx2-bb%2Fcontainer%2Fsrc%2Fbyte_string.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItYmIvY29udGFpbmVyL3NyYy9ieXRlX3N0cmluZy5ycw==) | `89.78% <ø> (ø)` | | | [iceoryx2-bb/container/src/vec.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?src=pr&el=tree&filepath=iceoryx2-bb%2Fcontainer%2Fsrc%2Fvec.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItYmIvY29udGFpbmVyL3NyYy92ZWMucnM=) | `90.54% <100.00%> (ø)` | | | [iceoryx2-bb/posix/src/directory.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?src=pr&el=tree&filepath=iceoryx2-bb%2Fposix%2Fsrc%2Fdirectory.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItYmIvcG9zaXgvc3JjL2RpcmVjdG9yeS5ycw==) | `62.55% <ø> (ø)` | | | [iceoryx2-bb/posix/src/message\_queue.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?src=pr&el=tree&filepath=iceoryx2-bb%2Fposix%2Fsrc%2Fmessage_queue.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItYmIvcG9zaXgvc3JjL21lc3NhZ2VfcXVldWUucnM=) | `76.62% <ø> (ø)` | | | [...c/dynamic\_storage/dynamic\_storage\_configuration.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?src=pr&el=tree&filepath=iceoryx2-cal%2Fsrc%2Fdynamic_storage%2Fdynamic_storage_configuration.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItY2FsL3NyYy9keW5hbWljX3N0b3JhZ2UvZHluYW1pY19zdG9yYWdlX2NvbmZpZ3VyYXRpb24ucnM=) | `66.00% <ø> (ø)` | | | [iceoryx2-cal/src/named\_concept.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?src=pr&el=tree&filepath=iceoryx2-cal%2Fsrc%2Fnamed_concept.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItY2FsL3NyYy9uYW1lZF9jb25jZXB0LnJz) | `78.84% <ø> (ø)` | | | [iceoryx2/src/iox2.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?src=pr&el=tree&filepath=iceoryx2%2Fsrc%2Fiox2.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDIvc3JjL2lveDIucnM=) | `0.00% <ø> (ø)` | | | [iceoryx2/src/port/port\_identifiers.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?src=pr&el=tree&filepath=iceoryx2%2Fsrc%2Fport%2Fport_identifiers.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDIvc3JjL3BvcnQvcG9ydF9pZGVudGlmaWVycy5ycw==) | `87.50% <ø> (ø)` | | | [iceoryx2/src/port/publisher.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?src=pr&el=tree&filepath=iceoryx2%2Fsrc%2Fport%2Fpublisher.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDIvc3JjL3BvcnQvcHVibGlzaGVyLnJz) | `82.89% <100.00%> (ø)` | | | [iceoryx2/src/sample.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?src=pr&el=tree&filepath=iceoryx2%2Fsrc%2Fsample.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDIvc3JjL3NhbXBsZS5ycw==) | `70.83% <ø> (ø)` | | | ... and [12 more](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx) | | ... and [4 files with indirect coverage changes](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/189/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx)