Skip to content

Commit

Permalink
Add some build reference doc for existing behavior (TriBITSPub#510, T…
Browse files Browse the repository at this point in the history
…riBITSPub#511)

I noticed that some important TriBITS logic that was not documented in the
build reference guide.  I noticed this while working on TriBITSPub#510 and TriBITSPub#511 (but,
again, this is just documenting existing behavior).
  • Loading branch information
bartlettroscoe committed Aug 11, 2022
1 parent 4691160 commit bfd9b6f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions tribits/doc/build_ref/TribitsBuildReferenceBody.rst
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,8 @@ Both of these variables are automatically enabled when
Enable a set of packages
++++++++++++++++++++++++

.. _<Project>_ENABLE_ALL_OPTIONAL_PACKAGES:

.. _<Project>_ENABLE_TESTS:

To enable an SE package ``<TRIBITS_PACKAGE>`` (and optionally also its tests
Expand Down Expand Up @@ -448,6 +450,9 @@ statement in an input ```*.cmake`` options files. However, setting
``-DXXX_ENABLE_YYY=TRUE`` and ``-DXXX_ENABLE_YYY=FALSE`` is allowed and will
be interpreted correctly..

NOTE: Setting ``<Project>_ENABLE_TESTS=ON`` also causes
``<Project>_ENABLE_EXAMPLES=ON`` to be set by default as well.


Enable or disable tests for specific packages
+++++++++++++++++++++++++++++++++++++++++++++
Expand Down Expand Up @@ -502,6 +507,11 @@ of their tests turned on. Tests will not be enabled in packages that do not
depend on ``<TRIBITS_PACKAGE>`` in this case. This speeds up and robustifies
pre-push testing.

NOTE: setting ``<Project>_ENABLE_ALL_FORWARD_DEP_PACKAGES=ON`` also
automatically sets and overrides `<Project>_ENABLE_ALL_OPTIONAL_PACKAGES`_ to
be ``ON`` as well. (It makes no sense to want to enable forward dependent
packages for testing purposes unless you are enabling all optional packages.)


Enable all packages (and optionally all tests)
++++++++++++++++++++++++++++++++++++++++++++++
Expand Down

0 comments on commit bfd9b6f

Please sign in to comment.