12 Commits

Author SHA1 Message Date
Léo Creuse
32704ab958 Run the doc sources through a spell checker 2025-03-17 09:26:12 +00:00
Matthieu Eyraud
657d1019a2 doc: remove outdated references to gnatcov_rts_full
We no longer have two versions of the runtime, but one version with
various build configuration, and a `gnatcov setup` command picking the
right configuration according to the target switches.

Also document the build + install of the coverage runtime using `gnatcov
setup` (which is the standard process) rather than manually building and
installing the runtime.
2023-10-03 12:59:19 +00:00
Matthieu Eyraud
37acd23476 Fix the documentation of the gnattest <-> gnatfuzz integration 2023-10-03 09:49:51 +00:00
Léo Creuse
2a72ad9d50 Doc: Add reference to gnatfuzz integration in the test generation part
This gives a more comprehensive view of all the Tagada items that are
currently supported in a single location.
2023-09-22 16:24:54 +00:00
Léo Creuse
9796cb5cbf Doc: Document basic integration between gnattest and gnatfuzz
Although the features are not mature, document them so as not to
confuse users when seeing new command line options with no matching
documentation in the users' guide.
2023-09-22 08:22:02 +00:00
Olivier Hainque
18b2c313ab Split bin trace support out of the main gnatcov user manual
Setup a new "part" (gnatcov_bin_part.rst) to hold a gnatcov
doc appendix dedicated to bin traces. Add a bin_intro.rst file
to hold the corresponding introduction chapter.

Add the new part to the top level index/toc (index.rst).

Rework the original getting_started chapter to focus on
source traces.

The rewritten getting_started uses a fig_flow_srctraces dot
to illustrate. The former fig_flow0 figure comparing the flows
is renamed as fig_flow_compare, adjusted and now used in the
intro section of the bintrace appendix.

Simplify text in the "integration" to get rid of references
to intro sections which are now incorrect.

Part of V805-004
2022-12-19 02:04:29 -08:00
Pierre-Marie de Rodat
1df3bfc3ff doc: introduce the :cmd-option: role and use it instead of :option:
:option: is meant to be used with the ".. option::" directive, as the
former creates xrefs to the later. We currently use only the former, so
Sphinx complains with tons of warnings about missing ".. option::"
directives:

  WARNING: unknown option: [...]

This commit introduces a new :cmd-option: role to use instead, which
(for the moment) has only formatting effects. Future changes could
enhance this role to add advanced xref features, such as creating an
index of options.

Change-Id: I40ae15c56e3397e55fd03b9146244853be8e085a
TN: V627-013
2022-07-07 15:31:16 +00:00
Pierre-Marie de Rodat
fe5cf2cd21 doc: fix various dangling :ref: references
Change-Id: I9cfacb63ed1f1b012854ac06a4d39a578d41f4fc
TN: V627-013
2022-07-06 08:07:09 +00:00
Pierre-Marie de Rodat
7bc7fd57fb doc: fix a typo
Change-Id: Ie3e3cddcfe42b992bf506789b875177c7bd32cc5
TN: V627-013
2022-07-01 14:41:51 +02:00
Pierre-Marie de Rodat
2d1de5b9ed doc: fix indentation issues
This minor reformatting gets rid of the following warning:

  WARNING: Bullet list ends without a blank line; unexpected unindent.
  WARNING: Block quote ends without a blank line; unexpected unindent.

Change-Id: I0eab24087e3bca1d6e15ee47ee48753a5a76def5
TN: V627-013
2022-07-01 14:41:51 +02:00
creuse
2930ac559f Document the usage of the instrumenter with SPARK sources
Also remove a configuration pragma from instrument-spark.adc, which
was not required in the general case for instrumentation purposes
but was instead specific to a single test in the testsuite.

Change-Id: I293196b8ff7e0a2e322fa30ac42d125bd5c81740
TN: U115-024
2021-09-28 17:03:58 +02:00
creuse
0f134c2af1 Document new integration Makefile and add example
This documents the integration Makefile generated by gnattest and
adds a new "integration" example to showcase its use and how it
can be used to avoid incidental coverage.

Change-Id: I981049b8a52fa8ecf1c782a89028010c764c91e6
TN: U115-024
2021-09-24 16:15:45 +02:00