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-#2080 Prefix 'Expects' and 'Ensures' with IOX #2081

Merged
merged 2 commits into from
Nov 9, 2023

Conversation

elBoberido
Copy link
Member

@elBoberido elBoberido commented Nov 8, 2023

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
  4. Branch follows the naming format (iox-123-this-is-a-branch)
  5. Commits messages are according to this guideline
  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

This PR adds an IOX prefix to Expects/Ensures to prevent conflicts with Microsoft GSL Expects macro

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

@elBoberido elBoberido added bugfix Solves a bug refactoring Refactor code without adding features labels Nov 8, 2023
@elBoberido elBoberido self-assigned this Nov 8, 2023
@elBoberido
Copy link
Member Author

@FerdinandSpitzschnueffler @mossmaurice @dkroenke @MatthiasKillat @elfenpiff @budrus feel free to add yourself as reviewer

@elBoberido elBoberido changed the title Iox 2080 prefix expects and ensures iox-#2080 Prefix 'Expects' and 'Ensures' with IOX Nov 8, 2023
Copy link

codecov bot commented Nov 8, 2023

Codecov Report

Merging #2081 (c6c56a5) into master (296c055) will not change coverage.
Report is 42 commits behind head on master.
The diff coverage is 88.16%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2081   +/-   ##
=======================================
  Coverage   80.13%   80.13%           
=======================================
  Files         417      417           
  Lines       16055    16055           
  Branches     2255     2255           
=======================================
  Hits        12865    12865           
  Misses       2385     2385           
  Partials      805      805           
Flag Coverage Δ
unittests 79.91% <88.16%> (ø)
unittests_timing 15.29% <15.37%> (ø)

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

Files Coverage Δ
iceoryx_binding_c/source/c_chunk.cpp 100.00% <100.00%> (ø)
iceoryx_binding_c/source/c_node.cpp 100.00% <100.00%> (ø)
iceoryx_binding_c/source/c_notification_info.cpp 100.00% <100.00%> (ø)
iceoryx_binding_c/source/c_publisher.cpp 92.50% <100.00%> (ø)
iceoryx_binding_c/source/c_request_header.cpp 100.00% <100.00%> (ø)
iceoryx_binding_c/source/c_response_header.cpp 100.00% <100.00%> (ø)
iceoryx_binding_c/source/c_runtime.cpp 80.00% <100.00%> (ø)
iceoryx_binding_c/source/c_service_discovery.cpp 98.38% <100.00%> (ø)
iceoryx_binding_c/source/c_subscriber.cpp 91.56% <100.00%> (ø)
iceoryx_binding_c/source/c_user_trigger.cpp 94.44% <100.00%> (ø)
... and 96 more

Copy link
Contributor

@mossmaurice mossmaurice left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@elBoberido
Copy link
Member Author

It seems the link checker has Problems with https://misra.org.uk/. I've manually confirmed that the link works but there was a weird 'robots' check before the site opened. It might be necessary to add that link to the ignore list.

@elBoberido elBoberido merged commit 443a0d8 into master Nov 9, 2023
23 of 25 checks passed
@elBoberido elBoberido deleted the iox-2080-prefix-expects-and-ensures branch November 9, 2023 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Solves a bug refactoring Refactor code without adding features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cxx::Expects macro conflicts with Microsoft GSL Expects macro
3 participants