diff --git a/README.rst b/README.rst index 5b1090f..0765fa5 100644 --- a/README.rst +++ b/README.rst @@ -193,7 +193,6 @@ between your branch and master, which it then forwards to ``cov-run-desktop``: cov-run-desktop --text-output-style=oneline `git diff --name-only --ignore-submodules master` - You can pipe the results to logfile, which you pass to warnings-plugin, or you use the ``--command`` argument and execute the ``cov-run-desktop`` through @@ -212,6 +211,50 @@ the ``--command`` argument and execute the ``cov-run-desktop`` through python -m mlx.warnings --coverity --command +We utilize `cov-run-desktop` in the following manner, where the output is saved in `coverity.log`: + +.. code-block:: bash + + cov-run-desktop --text-output-style=oneline --exit1-if-defects false --triage-attribute-regex "classification" ".*" | tee coverity.log + +Subsequently, we process the `coverity.log` file with the mlx-warnings plugin. +The plugin uses a configuration file (`warnings_coverity.yml`) and produces two outputs: +a text file (`warnings_coverity.txt`) and a code quality JSON file (`coverity_code_quality.json`). + +.. code-block:: bash + + mlx-warnings --config warnings_coverity.yml -o warnings_coverity.txt -C coverity_code_quality.json coverity.log + +This is an example of the configuration file: + +.. code-block:: yml + + sphinx: + enabled: false + doxygen: + enabled: false + junit: + enabled: false + xmlrunner: + enabled: false + coverity: + enabled: true + intentional: + max: -1 + bug: + max: 0 + pending: + max: 0 + false_positive: + max: -1 + robot: + enabled: false + polyspace: + enabled: false + +For each classification, a minimum and maximum can be given. + + Parse for JUnit Failures ------------------------ @@ -392,8 +435,14 @@ The values for 'min' and 'max' can be set with environment variables via a }, "coverity": { "enabled": false, - "min": 0, - "max": 0 + "bug": { + "min": 0, + "max": 0 + }, + "pending": { + "min": 0, + "max": 0 + } }, "robot": { "enabled": false,