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-#2057 Create deprecation macros #2059

Merged
merged 6 commits into from
Oct 25, 2023

Conversation

elBoberido
Copy link
Member

@elBoberido elBoberido commented Oct 25, 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 deprecation macros which depend on the iceoryx major version.

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 force-pushed the iox-2057-create-deprecation-macros branch from 3fee743 to b9b2c4a Compare October 25, 2023 02:20
@codecov
Copy link

codecov bot commented Oct 25, 2023

Codecov Report

Merging #2059 (b9b2c4a) into master (c5f549f) will not change coverage.
Report is 20 commits behind head on master.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2059   +/-   ##
=======================================
  Coverage   74.44%   74.44%           
=======================================
  Files         417      417           
  Lines       15986    15986           
  Branches     2272     2272           
=======================================
  Hits        11900    11900           
  Misses       3304     3304           
  Partials      782      782           
Flag Coverage Δ
unittests 74.22% <ø> (ø)
unittests_timing 15.31% <ø> (-0.02%) ⬇️

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

Files Coverage Δ
...oofs/internal/posix_wrapper/unix_domain_socket.hpp 100.00% <ø> (ø)
iceoryx_hoofs/time/include/iox/detail/duration.inl 92.69% <ø> (ø)

... and 1 file with indirect coverage changes

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.

Looks good in general. A few questions.

@elBoberido elBoberido merged commit 765cfd9 into master Oct 25, 2023
16 of 17 checks passed
@elBoberido elBoberido deleted the iox-2057-create-deprecation-macros branch October 25, 2023 21:22
elBoberido added a commit that referenced this pull request Oct 25, 2023
…ontainer-module

[Stacked on #2059] iox-#1391 Move list to container module
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create macros to deprecate header and code constructs Create iceoryx version header for the C-binding
3 participants