.. program:: gcovr

.. _text_output:
.. _txt_output:

Text Output
===========

The text output format summarizes coverage in a plain-text table.
This is the default output format if no other format is selected.
This output format can also be explicitly selected
with the :option:`--txt` option.

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.

.. versionadded:: 5.0
   Added explicit :option:`--txt` option.

Example output:

.. literalinclude:: ../../examples/example_txt.txt
    :language: text

Line Coverage
-------------

Running gcovr without any explicit output formats …

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

generates a text summary of the lines executed:

.. literalinclude:: ../../examples/example_txt.txt
    :language: text

The same result can be achieved when explicit :option:`--txt`
option is set. For example::

    gcovr --txt

generates the same text summary.

Each line of this output includes a summary for a given source file,
including the number of lines instrumented, the number of lines
executed, the percentage of lines executed, and a summary of the
line numbers that were not executed.  To improve clarity, gcovr
uses an aggressive approach to grouping uncovered lines and will
combine uncovered lines separated by "non-code" lines (blank,
freestanding braces, and single-line comments) into a single region.
As a result, the number of lines listed in the "Missing" list may
be greater than the difference of the "Lines" and "Exec" columns.

Note that ``gcov`` accumulates statistics by line.  Consequently, it
works best with a programming style that places only one statement
on each line.

..
    In ``example.cpp``, the ``MACRO`` macro executes a
    branch, but ``gcov`` cannot discern which branch is executed.


Branch Coverage
---------------

The ``gcovr`` command can also summarize branch coverage using
the :option:`-b/--branches <--branches>` option:

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

This generates a tabular output that summarizes the number of branches, the number of
branches taken and the branches that were not completely covered:

.. literalinclude:: ../../examples/example_branches.txt
    :language: text

The same result can be achieved when the :option:`--txt` option is
explicitly set. For example::

    gcovr --branches --txt

prints the same tabular output.