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

[#210] Adjust naming conventions for c binding #406

Conversation

elBoberido
Copy link
Member

@elBoberido elBoberido commented Sep 28, 2024

Notes for Reviewer

This PR adjust the naming convention for handle and pointer aliases for the C bindings

  • _ref_h becomes _h_ref
  • _mut_ptr becomes _ptr_mut

This makes is easier to find all occurrences of e.g. foo_ptr, independent of the mutability.

Additionally, the _h_ref types are now just an alias to *const _h. This makes quite a few casts obsolet.

Pre-Review Checklist for the PR Author

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

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Unit tests have been written for new behavior
  • Public API is documented
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

Relates to #210

@elBoberido elBoberido self-assigned this Sep 28, 2024
Copy link

codecov bot commented Sep 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.96%. Comparing base (59b0d3d) to head (8bba75c).
Report is 7 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #406      +/-   ##
==========================================
+ Coverage   78.93%   78.96%   +0.02%     
==========================================
  Files         194      194              
  Lines       22730    22730              
==========================================
+ Hits        17943    17948       +5     
+ Misses       4787     4782       -5     

see 2 files with indirect coverage changes

orecham
orecham previously approved these changes Sep 28, 2024
@elBoberido elBoberido force-pushed the iox2-210-adjust-naming-conventions-for-c-binding branch from e940b65 to aa1d7f5 Compare September 28, 2024 08:58
@elBoberido elBoberido force-pushed the iox2-210-adjust-naming-conventions-for-c-binding branch from 48cc492 to f230a93 Compare September 28, 2024 14:16
elfenpiff
elfenpiff previously approved these changes Sep 28, 2024
@elBoberido elBoberido force-pushed the iox2-210-adjust-naming-conventions-for-c-binding branch from a36e9bd to fb3b17e Compare September 28, 2024 14:32
@elfenpiff elfenpiff merged commit d58628c into eclipse-iceoryx:main Sep 28, 2024
49 of 56 checks passed
@elBoberido elBoberido deleted the iox2-210-adjust-naming-conventions-for-c-binding branch September 28, 2024 16:20
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.

3 participants