Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged

Conversation

mossmaurice
Copy link
Contributor

@mossmaurice mossmaurice commented Sep 1, 2022

Pre-Review Checklist for the PR Author

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

Notes for Reviewer

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

Checklist for the PR Reviewer

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

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

@mossmaurice mossmaurice added the documentation Improvements or additions to documentation label Sep 1, 2022
@mossmaurice mossmaurice self-assigned this Sep 1, 2022
@codecov
Copy link

codecov bot commented Sep 1, 2022

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%) ⬇️
unittests_timing 15.57% <ø> (-0.04%) ⬇️

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%) ⬇️
iceoryx_hoofs/source/posix_wrapper/mutex.cpp 43.54% <0.00%> (-41.75%) ⬇️
...osh/include/iceoryx_posh/internal/popo/trigger.inl 90.00% <0.00%> (-10.00%) ⬇️
...lude/iceoryx_posh/internal/popo/base_publisher.inl 90.90% <0.00%> (-9.10%) ⬇️
iceoryx_posh/source/popo/trigger_handle.cpp 82.53% <0.00%> (-7.12%) ⬇️
...hoofs/include/iceoryx_hoofs/internal/cxx/stack.inl 93.75% <0.00%> (-6.25%) ⬇️
iceoryx_hoofs/source/concurrent/loffli.cpp 85.71% <0.00%> (-5.72%) ⬇️
...ceoryx_dust/source/posix_wrapper/message_queue.cpp 63.58% <0.00%> (-5.44%) ⬇️
iceoryx_dust/source/posix_wrapper/named_pipe.cpp 52.10% <0.00%> (-4.22%) ⬇️
...lude/iceoryx_posh/internal/mepoo/mepoo_segment.inl 91.11% <0.00%> (-4.13%) ⬇️
... and 97 more

Copy link
Member

@dkroenke dkroenke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first two commits can be squashed

@mossmaurice
Copy link
Contributor Author

mossmaurice commented Sep 2, 2022

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 mossmaurice requested a review from dkroenke September 2, 2022 10:26
dkroenke
dkroenke previously approved these changes Sep 2, 2022
@dkroenke dkroenke force-pushed the iox-1295-update-component-diagram branch from b43df4b to 824b102 Compare September 13, 2022 12:52
dkroenke
dkroenke previously approved these changes Sep 13, 2022
@dkroenke dkroenke requested a review from elBoberido September 13, 2022 13:37
iceoryx_hoofs/README.md Outdated Show resolved Hide resolved
iceoryx_hoofs/README.md Outdated Show resolved Hide resolved
iceoryx_hoofs/README.md Outdated Show resolved Hide resolved
doc/design/diagrams/iceoryx_components_diagram_v3_0_0.puml Outdated Show resolved Hide resolved
@mossmaurice mossmaurice force-pushed the iox-1295-update-component-diagram branch from b5f4cca to 7ed1c22 Compare September 29, 2022 08:37
@mossmaurice mossmaurice force-pushed the iox-1295-update-component-diagram branch 3 times, most recently from ba22490 to 593eb85 Compare September 29, 2022 20:43
…module and create

'ipc' on one

Signed-off-by: Simon Hoinkis <[email protected]>
@mossmaurice mossmaurice force-pushed the iox-1295-update-component-diagram branch from 593eb85 to aeb182f Compare September 29, 2022 21:07
elBoberido
elBoberido previously approved these changes Sep 29, 2022
Copy link
Member

@elBoberido elBoberido left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I think we can merge this. I think the grouping would not be much more different if we continue to discuss this for another week.

Disclaimer: Didn't look for typos 😄

iceoryx_hoofs/README.md Show resolved Hide resolved
Copy link
Contributor

@elfenpiff elfenpiff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I only think that we really have to rename Queues into Buffer. When this is done I will approve it.

But if you have a fancy alternative I am also open for another name.

doc/design/diagrams/iceoryx_components_diagram_v3_0_0.puml Outdated Show resolved Hide resolved
iceoryx_hoofs/README.md Outdated Show resolved Hide resolved
doc/design/diagrams/iceoryx_components_diagram_v3_0_0.puml Outdated Show resolved Hide resolved
@mossmaurice mossmaurice force-pushed the iox-1295-update-component-diagram branch from 78397e7 to d22354c Compare October 4, 2022 10:12
@mossmaurice mossmaurice requested a review from elfenpiff October 4, 2022 14:44
Copy link
Contributor

@elfenpiff elfenpiff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add stack and variant queue to the Buffer table.

@mossmaurice
Copy link
Contributor Author

@elfenpiff

Please add stack and variant queue to the Buffer table.

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

@mossmaurice mossmaurice merged commit 7759074 into eclipse-iceoryx:master Oct 4, 2022
@mossmaurice mossmaurice deleted the iox-1295-update-component-diagram branch October 4, 2022 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Release validation for v3.0
5 participants