Criterion/doc/faq.rst
Ben Linskey e9f8d46c1b Add coverage info to FAQ in docs
Adds a question and answer explaining how to generate Gcov test coverage
data. Answer text is copied from https://github.com/Snaipe/Criterion/pull/84#issuecomment-161551069
2016-04-03 19:28:40 -04:00

23 lines
910 B
ReStructuredText

F.A.Q
=====
**Q. When running the test suite in Windows' cmd.exe, the test executable
prints weird characters, how do I fix that?**
A. Windows' ``cmd.exe`` is not an unicode ANSI-compatible terminal emulator.
There are plenty of ways to fix that behaviour:
* Pass ``--ascii`` to the test suite when executing.
* Define the ``CRITERION_USE_ASCII`` environment variable to ``1``.
* Get a better terminal emulator, such as the one shipped with Git or Cygwin.
**Q. I'm having an issue with the library, what can I do ?**
A. Open a new issue on the `github issue tracker <https://github.com/Snaipe/Criterion/issues>`_,
and describe the problem you are experiencing, along with the platform you are
running criterion on.
**Q. Why does Gcov show 0% coverage after I run my tests?**
You need to either pass ``--no-early-exit`` or define
``CRITERION_NO_EARLY_EXIT=1`` in your environment to get proper coverage.