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

CppCheck update suppress warning #10834

Merged
merged 1 commit into from
Dec 2, 2024
Merged

CppCheck update suppress warning #10834

merged 1 commit into from
Dec 2, 2024

Conversation

rraustad
Copy link
Contributor

Pull request overview

  • Fixes recent warnings of missing include files

NOTE: ENHANCEMENTS MUST FOLLOW A SUBMISSION PROCESS INCLUDING A FEATURE PROPOSAL AND DESIGN DOCUMENT PRIOR TO SUBMITTING CODE

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@rraustad rraustad added the DoNotPublish Includes changes that shouldn't be reported in the changelog label Nov 26, 2024
@@ -46,7 +46,8 @@ jobs:
--force
--std=c++17
--inline-suppr
--suppress=cppcheckError
--suppress=missingInclude
--suppress=missingIncludeSystem
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixes:

[nofile:0]:(information),[unmatchedSuppression],Unmatched suppression: cppcheckError

And the 6000 warnings like this (is there a better way to allow checking for missing includes?):

[src/ConvertInputFormat/main.cpp:51]:(information),[missingInclude],Include file: "EnergyPlus/InputProcessing/InputValidation.hh" not found.
[src/ConvertInputFormat/main.cpp:52]:(information),[missingIncludeSystem],Include file: <embedded/EmbeddedEpJSONSchema.hh> not found. Please note: Cppcheck does not need standard library headers to get proper results.

@rraustad
Copy link
Contributor Author

rraustad commented Nov 26, 2024

Before:

image

After:

image

@rraustad rraustad changed the title Update CppCheck suppress warning CppCheck update suppress warning Nov 27, 2024
@Myoldmopar
Copy link
Member

This seems like a nice change to highlight the actual issues and suggestions. Good to go @rraustad

@Myoldmopar Myoldmopar merged commit 3fa9c14 into develop Dec 2, 2024
11 checks passed
@Myoldmopar Myoldmopar deleted the CppCheckSuppressFix branch December 2, 2024 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DoNotPublish Includes changes that shouldn't be reported in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants