summaryrefslogtreecommitdiff
path: root/test/unit-test/vendor/ceedling/plugins/warnings_report/README.md
blob: fd7fae5d94bcf00e654b45f76cea6862e1b307ad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
warnings-report
===============

## Overview

The warnings_report captures all warnings throughout the build process
and collects them into a single report at the end of execution. It places all
of this into a warnings file in the output artifact directory.

## Setup

Enable the plugin in your project.yml by adding `warnings_report`
to the list of enabled plugins.

``` YAML
:plugins:
  :enabled:
    - warnings_report
```