Skip to content

Commit

Permalink
Cetmodules documentation update (develop-9d16296)
Browse files Browse the repository at this point in the history
  • Loading branch information
Art CI system committed Oct 18, 2023
1 parent bb4f8ca commit 4b67e73
Show file tree
Hide file tree
Showing 141 changed files with 2,795 additions and 707 deletions.
1 change: 1 addition & 0 deletions git-develop/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Command-Line Tools

manual/buildtool.1
manual/code-dep-graph.1
manual/filter-output.1
manual/format-code.1
manual/intersphinx-refs.1

Expand Down
16 changes: 9 additions & 7 deletions git-develop/_sources/manual/buildtool.1.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@ buildtool(1)
Synopsis
========

:program:`buildtool` [:ref:`mode-option <buildtool-mode-options>`\|\
:ref:`combo-option <buildtool-combo-options>` ...] [:ref:`misc-options
<buildtool-misc-options>`] [``--`` [:ref:`CMake build options
<buildtool-cmake-build-options>`] [``--`` :ref:`generator options
<buildtool-generator-options>`]]
.. parsed-literal::
:program:`buildtool`\ :option:`--help`\|\ :option:`-h`
:program:`buildtool` [:ref:`mode-option <buildtool-mode-options>`\|\
:ref:`combo-option <buildtool-combo-options>` ...] [:ref:`misc-options
<buildtool-misc-options>`]
[``--`` [:ref:`CMake build options <buildtool-cmake-build-options>`]\
[``--`` :ref:`generator options <buildtool-generator-options>`]]
:program:`buildtool`\ :option:`--usage`
:program:`buildtool`\ :option:`--help`\|\ :option:`-h`
:program:`buildtool`\ :option:`--usage`
:ref:`Exclusive mode options <buildtool-mode-options>`: :option:`-A`\|\
:option:`--all` :option:`-C`\|\ :option:`--cmake-only` :option:`--info`
Expand Down
14 changes: 9 additions & 5 deletions git-develop/_sources/manual/cetmodules-commands.7.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,17 @@ Generation, Installation, and Export

* :command:`basic_plugin`
* :command:`build_dictionary`
* :command:`cet_copy`
* :command:`check_class_version`
* :command:`cet_cmake_config`
* :command:`cet_cmake_module_directories`
* :command:`cet_make_alias`
* :command:`cet_make_library`
* :command:`cet_make_exec`
* :command:`cet_register_export_set`
* :command:`cet_script`
* :command:`cet_test`
* :command:`install_pkgmeta`

Utility
=======
Expand All @@ -35,14 +41,12 @@ Utility
* :command:`cet_passthrough`
* :command:`cet_real_path`
* :command:`cet_source_file_extensions`
* :command:`cet_test_assertion`
* :command:`cet_test_env`
* :command:`cet_timestamp`

Compatibility
=============



Deprecated
==========

* :command:`cet_find_simple_package`
* :command:`cet_register_export_name`
61 changes: 61 additions & 0 deletions git-develop/_sources/manual/filter-output.1.rst.txt
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)
6 changes: 6 additions & 0 deletions git-develop/_sources/variable/PROJECT-NAME_BIN_DIR.rst.txt
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>`
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`.
5 changes: 5 additions & 0 deletions git-develop/_sources/variable/PROJECT-NAME_NAMESPACE.rst.txt
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.
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.
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>`.

2 changes: 1 addition & 1 deletion git-develop/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: 'git-develop-1ffbe95',
VERSION: 'git-develop-9d16296',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
8 changes: 4 additions & 4 deletions git-develop/envvar/PATH.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<title>PATH &mdash; Cetmodules git-develop-1ffbe95 Reference</title>
<title>PATH &mdash; Cetmodules git-develop-9d16296 Reference</title>

<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a2c47e09" />
<link rel="stylesheet" type="text/css" href="../_static/cetmodules.css?v=69c2d5a6" />
Expand All @@ -14,7 +14,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=567c09b0"></script>
<script src="../_static/documentation_options.js?v=96328d05"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/bootstrap.bundle.min.js?v=89176c1c"></script>
Expand Down Expand Up @@ -55,7 +55,7 @@ <h3>Navigation</h3>
<a href="../../">Cetmodules Documentation</a> &#187;
</li>
<li>
<span class="version_switch">git-develop-1ffbe95</span>
<span class="version_switch">git-develop-9d16296</span>
<a href="../index.html">Reference</a> &#187;
</li>

Expand Down Expand Up @@ -146,7 +146,7 @@ <h3>Navigation</h3>
<a href="../../">Cetmodules Documentation</a> &#187;
</li>
<li>
<span class="version_switch">git-develop-1ffbe95</span>
<span class="version_switch">git-develop-9d16296</span>
<a href="../index.html">Reference</a> &#187;
</li>

Expand Down
Loading

0 comments on commit 4b67e73

Please sign in to comment.