iceoryx icon indicating copy to clipboard operation
iceoryx copied to clipboard

iox-#1295 Update component and layer diagram for upcoming release

Open mossmaurice opened this issue 3 years ago • 2 comments

Pre-Review Checklist for the PR Author

  1. [x] Code follows the coding style of CONTRIBUTING.md
  2. [x] Tests follow the best practice for testing
  3. [x] ~~Changelog updated in the unreleased section including API breaking changes~~ No user API changed
  4. [x] Branch follows the naming format (iox-123-this-is-a-branch)
  5. [x] Commits messages are according to this guideline
    • [x] Commit messages have the issue ID (iox-#123 commit text)
    • [x] Commit messages are signed (git commit -s)
    • [x] Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  6. [x] Update the PR title
    • Follow the same conventions as for commit messages
    • Link to the relevant issue
  7. [x] Relevant issues are linked
  8. [x] Add sensible notes for the reviewer
  9. [x] All checks have passed (except task-list-completed)
  10. [x] All touched (C/C++) source code files from iceoryx_hoofs are added to ./clang-tidy-diff-scans.txt
  11. [x] Assign PR to reviewer

Notes for Reviewer

  • Add component and layer diagram for upcoming v3.x release

Checklist for the PR Reviewer

  • [x] Commits are properly organized and messages are according to the guideline
  • [x] Code according to our coding style and naming conventions
  • [x] Unit tests have been written for new behavior
  • [x] Public API changes are documented via doxygen
  • [x] Copyright owner are updated in the changed files
  • [x] All touched (C/C++) source code files from iceoryx_hoofs have been added to ./clang-tidy-diff-scans.txt
  • [x] PR title describes the changes

Post-review Checklist for the PR Author

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

References

  • Closes #1295 (partly)

mossmaurice avatar Sep 01 '22 09:09 mossmaurice

Codecov Report

Merging #1600 (bc37ad9) into master (65f20a7) will decrease coverage by 0.78%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1600      +/-   ##
==========================================
- Coverage   78.20%   77.42%   -0.79%     
==========================================
  Files         360      366       +6     
  Lines       13862    14167     +305     
  Branches     1942     1984      +42     
==========================================
+ Hits        10841    10969     +128     
- Misses       2418     2569     +151     
- Partials      603      629      +26     
Flag Coverage Δ
unittests 77.08% <ø> (-0.78%) :arrow_down:
unittests_timing 15.57% <ø> (-0.04%) :arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...ceoryx_hoofs/include/iceoryx_hoofs/log/logging.hpp 50.00% <0.00%> (-50.00%) :arrow_down:
iceoryx_hoofs/source/posix_wrapper/mutex.cpp 43.54% <0.00%> (-41.75%) :arrow_down:
...osh/include/iceoryx_posh/internal/popo/trigger.inl 90.00% <0.00%> (-10.00%) :arrow_down:
...lude/iceoryx_posh/internal/popo/base_publisher.inl 90.90% <0.00%> (-9.10%) :arrow_down:
iceoryx_posh/source/popo/trigger_handle.cpp 82.53% <0.00%> (-7.12%) :arrow_down:
...hoofs/include/iceoryx_hoofs/internal/cxx/stack.inl 93.75% <0.00%> (-6.25%) :arrow_down:
iceoryx_hoofs/source/concurrent/loffli.cpp 85.71% <0.00%> (-5.72%) :arrow_down:
...ceoryx_dust/source/posix_wrapper/message_queue.cpp 63.58% <0.00%> (-5.44%) :arrow_down:
iceoryx_dust/source/posix_wrapper/named_pipe.cpp 52.10% <0.00%> (-4.22%) :arrow_down:
...lude/iceoryx_posh/internal/mepoo/mepoo_segment.inl 91.11% <0.00%> (-4.13%) :arrow_down:
... and 97 more

codecov[bot] avatar Sep 01 '22 10:09 codecov[bot]

The first two commits can be squashed

@dkroenke Typically, I prefer to keep separate things in separate commits, so you can later e.g. revert them individually with git revert. I can squash those commits, if you feel this is too much overhead.

mossmaurice avatar Sep 02 '22 10:09 mossmaurice

@elfenpiff

Please add stack and variant queue to the Buffer table.

:heavy_check_mark: I didn't add VariantQueue as it will be moved to iceoryx_posh soon and has variable attributes.

mossmaurice avatar Oct 04 '22 17:10 mossmaurice