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

Using logging functions to standardize the std::cerr output messages #878

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

stcui007
Copy link
Contributor

@stcui007 stcui007 commented Aug 23, 2024

Using functions defined in src/utilities/logging/logging_utils.cpp, this PR replaces each std::cerr output in the framework code with a properly classified function so that the nature of the std::cerr instance is more easily recognizibale. The logging function classifications are as follows:
logging::debug(...)
logging::info(...)
logging::warning(...)
logging::error(...)
logging::critical(...)
logging::formatting(...)

Additions

A new logging function logging::formatting(...) to accomodate multiline output without interuption.

Removals

Changes

As shown in the commit

Testing

Unit tests on local machine
ngen run tests in serial and mpi modes

Screenshots

Notes

Todos

Checklist

  • [x ] PR has an informative and human-readable title
  • [x ] Changes are limited to a single goal (no scope creep)
  • [x ] Code can be automatically merged (no conflicts)
  • [x ] Code follows project standards (link if applicable)
  • [x ] Passes all existing automated tests
  • [x ] Any change in functionality is tested
  • [x ] New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • [x ] Reviewers requested with the Reviewers tool ➡️

Testing checklist (automated report can be put here)

Target Environment support

  • [x ] Linux

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.

1 participant