Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Ezio Melotti <[email protected]>
  • Loading branch information
hugovk and ezio-melotti authored Aug 24, 2024
1 parent 3aeb0c9 commit 6ca97f8
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions development-tools/warnings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,14 @@ by running::

python Tools/build/check_warnings.py --help

The script can be run locally by providing the compiler output and the
compiler output type to see a list of unique warnings.
The script can be run locally by providing the compiler output file
(where the output is saved) and the compiler output type
(either ``json`` or ``clang``) to see a list of unique warnings::

::
python Tools/build/check_warnings.py --compiler-output-file-path=compiler_output.txt --compiler-output-type=json

$ python Tools/build/check_warnings.py -c <compiler_output_file> -t <compiler_output_type>

..
Note: `-fdiagnostics-format=json` flag is required when compiling with GCC
for the script to properly parse the compiler output.
.. note:: The ``-fdiagnostics-format=json`` flag is required when compiling with GCC
for the script to properly parse the compiler output.

.. _warning-check-failure:

Expand Down

0 comments on commit 6ca97f8

Please sign in to comment.