Skip to content

Commit

Permalink
📝 Improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mkarlesky committed Jul 16, 2024
1 parent 331a769 commit a8c0834
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions plugins/report_tests_raw_output_log/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ test cases to log files.
# Plugin Overview

This plugin gathers and filters console output from test executables into log
files.
files. Though not required, it is usually used in addition to the
`report_tests_*_stdout` plugins that gather and format test results for display
at the console.

Debugging in unit tested code is often accomplished with simple `printf()`-
style calls to dump information to the console. This plugin's log files can be
Expand All @@ -16,10 +18,12 @@ helpful in supporting debugging efforts or quality validation.

Ceedling and Unity cooperate to extract console statements from test executable
runs. Unity-based test executables print test case pass/fail status messages
and test case accounting to the console ($stdout). Ceedling and various
reporting plugins gather all this, including unrecognized output, to format it
and present summaries at the console. This plugin captures the unrecognized
output to log files.
and test case accounting to the console ($stdout).

Ceedling and various reporting plugins gather all this, including unrecognized
output, to format it and present summaries at the console.

This plugin captures the unrecognized output to log files.

## Log files

Expand Down

0 comments on commit a8c0834

Please sign in to comment.