-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cetmodules documentation update (develop-9d16296)
- Loading branch information
Art CI system
committed
Oct 18, 2023
1 parent
bb4f8ca
commit 4b67e73
Showing
141 changed files
with
2,795 additions
and
707 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
.. cmake-manual-description: output filter for test reference comparisons | ||
filter-output(1) | ||
**************** | ||
|
||
.. program:: filter-output | ||
|
||
Synopsis | ||
======== | ||
|
||
.. parsed-literal:: | ||
``<my-test-program>`` ``[<arg> ...]`` | :program:`filter-output` | ||
Description | ||
=========== | ||
|
||
\ :program:`filter-output` is a filter, receiving input on ``STDIN`` and | ||
producing output on ``STDOUT``. | ||
|
||
\ :program:`filter-output` is usually invoked as part of a test | ||
configured using the :command:`cet_test` command in order to sanitize | ||
the test-output to improve its suitability for comparison with a | ||
reference to (e.g.) detect regressions. It may also be used in order to | ||
produce such references for later comparison. | ||
|
||
Details | ||
======= | ||
|
||
The following transformations are performed on | ||
:program:`filter-output`'s input: | ||
|
||
* Recognizable date/time formats -> ``<date-time>``. | ||
|
||
* Variable length separator/filler strings of at least 15 consecutive | ||
occurrences of the same symbol (``-``, ``=``, ``.``, ``*``, ``~`` or | ||
``/``) -> ``<separator (<char>)>``. | ||
|
||
* Platform identifiers starting with ``Darwin`` or ``Linux`` -> | ||
``<platform>``. | ||
|
||
.. admonition:: `art <https://art.fnal.gov/>`_ | ||
:class: admonition-app | ||
|
||
* Absolute paths to source files ending in | ||
``_(plugin|module|service|tool).cc`` are truncated to ``<path>/``. | ||
|
||
* ``TimeReport`` values -> ``<duration>`` | ||
|
||
* ``MemReport`` sections are elided. | ||
|
||
Examples | ||
======== | ||
|
||
* .. code-block:: console | ||
|
||
$ my-test | filter-output >my-test-ref.out 2>my-test-ref.err | ||
|
||
* .. parsed-literal:: | ||
|
||
:command:`cet_test <cet_test(HANDBUILT)>`\ (my-test HANDBUILT TEST_EXEC my-test REF my-test-ref.out my-test-ref.err) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
<PROJECT-NAME>_BIN_DIR | ||
-------------------------- | ||
|
||
Installation directory for executables. | ||
|
||
.. seealso:: :module:`GNUInstallDirs <cmake-ref-current:module:GNUInstallDirs>` |
5 changes: 5 additions & 0 deletions
5
git-develop/_sources/variable/PROJECT-NAME_DEFAULT_EXPORT_SET.rst.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
<PROJECT-NAME>_DEFAULT_EXPORT_SET | ||
--------------------------------- | ||
|
||
Default export set to be used by subsequent invocations of | ||
:command:`cet_make_library` and :command:`cet_make_exec`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
<PROJECT-NAME>_NAMESPACE | ||
------------------------ | ||
|
||
Default namespace to be used for a project's exported targets and local | ||
aliases. |
5 changes: 5 additions & 0 deletions
5
git-develop/_sources/variable/PROJECT-NAME_SCRIPTS_DIR.rst.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
<PROJECT-NAME>_SCRIPTS_DIR | ||
-------------------------- | ||
|
||
Installation scripts directory; defaults to | ||
:variable:`<PROJECT-NAME>_BIN_DIR` if specified; ``scripts`` if not. |
7 changes: 7 additions & 0 deletions
7
git-develop/_sources/variable/PROJECT-NAME_TEST_DEPS_AS_FIXTURES.rst.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<PROJECT-NAME>_TEST_DEPS_AS_FIXTURES | ||
------------------------------------ | ||
|
||
If ``TRUE``, the :ref:`REQUIRED_TESTS <cet_test-REQUIRED_TESTS-opt>` | ||
option to :command:`cet_test` will be treated as a synonym for | ||
:ref:`REQUIRED_FIXTURES <cet_test-REQUIRED_FIXTURES-opt>`. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.