.. program:: gcovr

.. _csv_output:

CSV Output
==========

The :option:`--csv` option output comma-separated values
summarizing the coverage of each file. Consider the following command:

.. literalinclude:: ../../examples/example_csv.sh
    :language: bash
    :start-after: #BEGIN gcovr
    :end-before: #END gcovr

This generates an CSV:

.. literalinclude:: ../../examples/example_csv.csv
    :language: text

Be careful if you print the output of a CSV to STDOUT and redirect it to
a file. According to :rfc:`4180`, the line endings must be CRLF.

If the given name ends with the suffix ``.gz`` the report is compressed by gzip,
if it ends with ``.xz`` it is compressed by LZMA.
The file needs to be unzipped before using as input for other tools.

.. versionadded:: 5.0
   Added :option:`--csv`.