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-#1755 Distinct overloads for arithmetic types for logstream #2022

Conversation

elBoberido
Copy link
Member

@elBoberido elBoberido commented Sep 6, 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 distinct overloads for LogStream& operator <<. This enabled implicit type conversion to the underlying type of e.g. Wrapper<T> if the implicit operator T() is implemented.

Additionally, it is finally possible to log char instead of only signed char and unsigned char.

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

@codecov
Copy link

codecov bot commented Sep 6, 2023

Codecov Report

Merging #2022 (95e4a7c) into master (c5d1340) will increase coverage by 0.04%.
Report is 4 commits behind head on master.
The diff coverage is 91.83%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2022      +/-   ##
==========================================
+ Coverage   74.27%   74.32%   +0.04%     
==========================================
  Files         413      413              
  Lines       16055    16103      +48     
  Branches     2246     2246              
==========================================
+ Hits        11925    11968      +43     
- Misses       3411     3415       +4     
- Partials      719      720       +1     
Flag Coverage Δ
unittests 74.11% <91.83%> (+0.04%) ⬆️
unittests_timing 15.20% <0.00%> (-0.05%) ⬇️

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

Files Changed Coverage Δ
...clude/iox/detail/log/building_blocks/logformat.inl 76.47% <ø> (ø)
...ofs/reporting/include/iox/detail/log/logstream.inl 95.79% <91.83%> (-2.80%) ⬇️

... and 1 file with indirect coverage changes

Copy link
Contributor

@FerdinandSpitzschnueffler FerdinandSpitzschnueffler left a comment

Choose a reason for hiding this comment

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

I found some typos, but you can ignore my comment and merge if there's nothing else to change.

iceoryx_hoofs/reporting/include/iox/log/logstream.hpp Outdated Show resolved Hide resolved
mossmaurice
mossmaurice previously approved these changes Sep 16, 2023
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, only minor nitpicks. From my side we can merge this.

@elBoberido elBoberido force-pushed the iox-1755-distinct-overloads-for-arithmetic-types-for-logstream branch from 6062429 to 95e4a7c Compare September 16, 2023 13:01
@elBoberido elBoberido merged commit f834f28 into eclipse-iceoryx:master Sep 18, 2023
17 checks passed
@elBoberido elBoberido deleted the iox-1755-distinct-overloads-for-arithmetic-types-for-logstream branch September 18, 2023 11:08
@elBoberido elBoberido linked an issue Sep 18, 2023 that may be closed by this pull request
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance Logger
3 participants