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-#1196 Add lint suppressions and fix warnings for PoorMansHeap #1467

Merged

Conversation

elBoberido
Copy link
Member

@elBoberido elBoberido commented Jul 7, 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
  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. Assign PR to reviewer

Notes for Reviewer

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
    • Each unit test case has a unique UUID
  • Public API changes are documented via doxygen
  • Copyright owner are updated in the changed files
  • 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 refactoring Refactor code without adding features technical debt unclean code and design flaws labels Jul 7, 2022
@elBoberido elBoberido self-assigned this Jul 7, 2022
@codecov
Copy link

codecov bot commented Jul 7, 2022

Codecov Report

Merging #1467 (4629e49) into master (fd6b5e4) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1467      +/-   ##
==========================================
- Coverage   78.78%   78.78%   -0.01%     
==========================================
  Files         377      377              
  Lines       14474    14474              
  Branches     2009     2009              
==========================================
- Hits        11404    11403       -1     
- Misses       2433     2434       +1     
  Partials      637      637              
Flag Coverage Δ
unittests 78.44% <ø> (-0.01%) ⬇️
unittests_timing 14.89% <ø> (ø)

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

Impacted Files Coverage Δ
...hoofs/include/iceoryx_hoofs/cxx/poor_mans_heap.hpp 100.00% <ø> (ø)
...lude/iceoryx_hoofs/internal/cxx/poor_mans_heap.inl 100.00% <ø> (ø)
iceoryx_hoofs/source/concurrent/loffli.cpp 85.71% <0.00%> (-2.86%) ⬇️
...fs/include/iceoryx_hoofs/internal/cxx/optional.inl 93.06% <0.00%> (ø)

@elBoberido elBoberido changed the title iox-#1196 Add lint suppressions and fix warnings iox-#1196 Add lint suppressions and fix warnings for PoorMansHeap Jul 7, 2022
@elBoberido elBoberido requested review from mossmaurice and FerdinandSpitzschnueffler and removed request for elfenpiff July 7, 2022 09:56
@mossmaurice mossmaurice added clang-tidy Warning of a clang-tidy rule and removed refactoring Refactor code without adding features technical debt unclean code and design flaws labels Jul 7, 2022
@@ -23,7 +23,7 @@ namespace iox
{
namespace cxx
{
// AXIVION Construct Ruleset-A12.1.1 : it is guaranteed that the array elements are initialized on access
// AXIVION Construct AutosarC++19_03-A12.1.1 : it is guaranteed that the array elements are initialized on access
Copy link
Contributor

@mossmaurice mossmaurice Jul 7, 2022

Choose a reason for hiding this comment

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

@elBoberido I don't get A12.1.1 reported in stack when removing this rule and running the check locally.

@dkroenke @neillangmead41 Could you check that?

Copy link
Contributor

Choose a reason for hiding this comment

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

@@ -50,12 +50,12 @@ class stack // NOLINT (cppcoreguidelines-pro-type-member-init,hicpp-member-init)
static constexpr uint64_t capacity() noexcept;

private:
// AXIVION Next Line Ruleset-A18.1.1 : safe access is guaranteed since the char array is wrapped inside the stack
// class
// AXIVION Next Line AutosarC++19_03-A18.1.1 : safe access is guaranteed since the char array is wrapped inside the
Copy link
Contributor

Choose a reason for hiding this comment

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

@neillangmead41 @dkroenke This suppression works fine.

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.

Besides the Axivion scan nitpicks, LGTM!

@elBoberido elBoberido merged commit 90e1ebe into eclipse-iceoryx:master Jul 7, 2022
@elBoberido elBoberido deleted the iox-#1196-fix-poor-mans-heap branch July 7, 2022 14:06
@elBoberido elBoberido linked an issue Jul 7, 2022 that may be closed by this pull request
85 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang-tidy Warning of a clang-tidy rule
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable clang-tidy checks and fix warnings in code
4 participants