Update documentation.

gcovr · Apr 9, 2023 · 37fb849 · 37fb849
1 parent 40876b3
commit 37fb849
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 8 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -223,21 +223,25 @@ Project Structure
 Path Description
 ======================= =======================================================
 ``/`` project root
+``/.github/`` GitHub actions and PR templates
+``/admin/`` Administrative scripts and Dockerfile
+``/doc/`` documentation
+``/doc/sources/`` user guide + website
+``/doc/examples/`` runnable examples for the user guide
 ``/gcovr/`` the gcovr source code (Python module)
-``/gcovr/__main__.py`` command line interface + top-level behaviour
-``/gcovr/templates/`` HTML report templates
+``/gcovr/__main__.py`` command line interface + top-level behavior
+``/gcovr/exclusions/`` Exclusion processing of coverage data
+``/gcovr/formats/`` Input/output format handlers
 ``/gcovr/tests/`` unit tests + integration test corpus
+``/scripts/`` Entry point for standalone executable
 ``/noxfile.py`` Definition of tests tasks
 ``/setup.py`` Python package configuration
-``/doc/`` documentation
-``/doc/sources/`` user guide + website
-``/doc/examples/`` runnable examples for the user guide
 ======================= =======================================================
 
 The program entrypoint and command line interface is in ``gcovr/__main__.py``.
-The coverage data is parsed in the ``gcovr.gcov`` module.
+The coverage data is parsed in the ``gcovr.formats.gcov`` module.
 The HTML, XML, text, and summary reports
-are in ``gcovr.generator.html`` and respective modules.
+are in ``gcovr.formats.html`` and respective modules.
 
 .. _test suite:
 

diff --git a/doc/source/faq.rst b/doc/source/faq.rst
@@ -150,5 +150,6 @@ Following options are always used:
 
 Following options are only used if available:
 
+- ``--json-format``: Use JSON intermediate format. Can only be used if no calls are needed in the report.
 - ``--demangled-names``: Not available for LLVM based ``gcov``.
 - ``--hash-filenames``: Available since GCC 7, as fallback the option ``--preserve-paths`` is used.
diff --git a/doc/source/guide/filters.rst b/doc/source/guide/filters.rst
@@ -58,7 +58,7 @@ and must not match any :option:`-e/--exclude<gcovr --exclude>` filter.
 
 The :option:`--gcov-filter<gcovr --gcov-filter>`
 and :option:`--gcov-exclude<gcovr --gcov-exclude>` filters apply to the
-``.gcov`` files created by ``gcov``.
+``.gcov`` / ``.json.gz`` files created by ``gcov``.
 This is useful mostly when running gcov yourself,
 and then invoking gcovr with :option:`-g/--use-gcov-files<gcovr --use-gcov-files>`.
 But these filters also apply when gcov is launched by gcovr.