Skip to content

Commit

Permalink
Doc: Fix var renaming from OPTIONAL_DEP_PACKAGE_NAME to UPSTREAM_PACK…
Browse files Browse the repository at this point in the history
…AGE_NAME (TriBITSPub#63)

In an earlier refactoring to combine the handling of internal and external
packages, only a partial renaming of vars in the documentation was completed
correctly.  I just noticed this while reading the documentation while doing a
Trilinos PR review where I referred to this documentation.
  • Loading branch information
bartlettroscoe committed Jan 31, 2024
1 parent 9328b34 commit 2dfb4b4
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions tribits/doc/guides/TribitsGuidesBody.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1589,25 +1589,25 @@ are defined before a Package's ``CMakeLists.txt`` file is processed:
imply that all of the required subpackages will be enabled, only that the
parent package will be processed).

.. _${PACKAGE_NAME}_ENABLE_${OPTIONAL_DEP_PACKAGE_NAME}:
.. _${PACKAGE_NAME}_ENABLE_${UPSTREAM_PACKAGE_NAME}:

``${PACKAGE_NAME}_ENABLE_${OPTIONAL_DEP_PACKAGE_NAME}``
``${PACKAGE_NAME}_ENABLE_${UPSTREAM_PACKAGE_NAME}``

Set to ``ON`` if support for the optional `upstream`_ dependent package
``${OPTIONAL_DEP_PACKAGE_NAME}`` is enabled in package
``${PACKAGE_NAME}``. Here ``${OPTIONAL_DEP_PACKAGE_NAME}`` corresponds to
``${UPSTREAM_PACKAGE_NAME}`` is enabled in package
``${PACKAGE_NAME}``. Here ``${UPSTREAM_PACKAGE_NAME}`` corresponds to
each optional upstream package listed in the ``LIB_OPTIONAL_PACKAGES``
and ``TEST_OPTIONAL_PACKAGES`` arguments to the
`tribits_package_define_dependencies()`_ macro.

**NOTE:** It is important that the CMake code in the package's
``CMakeLists.txt`` files key off of this variable and **not** the
project-level variable
``${PROJECT_NAME}_ENABLE_${OPTIONAL_DEP_PACKAGE_NAME}`` because the
``${PROJECT_NAME}_ENABLE_${UPSTREAM_PACKAGE_NAME}`` because the
package-level variable
``${PACKAGE_NAME}_ENABLE_${OPTIONAL_DEP_PACKAGE_NAME}`` can be explicitly
``${PACKAGE_NAME}_ENABLE_${UPSTREAM_PACKAGE_NAME}`` can be explicitly
turned off by the user even through the packages ``${PACKAGE_NAME}`` and
``${OPTIONAL_DEP_PACKAGE_NAME}`` are both enabled at the project level!
``${UPSTREAM_PACKAGE_NAME}`` are both enabled at the project level!
See `Support for optional package can be explicitly disabled`_.

**NOTE:** This variable will also be set for required dependencies as well
Expand Down Expand Up @@ -1648,12 +1648,12 @@ are defined in the top-level project scope before a Package's
``HAVE_<PACKAGE_NAME_UC>_<UPSTREAM_PACKAGE_NAME_UC>``

Set to ``ON`` if support for optional upstream package
``${OPTIONAL_DEP_PACKAGE}`` is enabled in downstream package
``${UPSTREAM_PACKAGE_NAME`` is enabled in downstream package
``${PACKAGE_NAME}``
(i.e. `${PACKAGE_NAME}_ENABLE_${OPTIONAL_DEP_PACKAGE_NAME}`_ = ``ON``) and
is set to ``FALSE`` otherwise. Here, ``<PACKAGE_NAME_UC>`` and
(i.e. `${PACKAGE_NAME}_ENABLE_${UPSTREAM_PACKAGE_NAME}`_ = ``ON``) and is
set to ``FALSE`` otherwise. Here, ``<PACKAGE_NAME_UC>`` and
``<UPSTREAM_PACKAGE_NAME_UC>`` are the upper-case names for the packages
``${PACKAGE_NAME}`` and ``${OPTIONAL_DEP_PACKAGE_NAME}``, respectively.
``${PACKAGE_NAME}`` and ``${UPSTREAM_PACKAGE_NAME}``, respectively.
For example, if optional support for upstream package ``Triutils`` is
enabled in downstream package ``EpetraExt`` in `ReducedMockTrilinos`_,
then ``EpetraExt_ENABLE_TriUtils=ON`` and ``HAVE_EPETRAEXT_TRIUTILS=ON``.
Expand All @@ -1668,7 +1668,7 @@ are defined in the top-level project scope before a Package's
#cmakedefine HAVE_EPETRAEXT_TRIUTILS

NOTE: TriBITS automatically sets this variable depending on the value of
`${PACKAGE_NAME}_ENABLE_${OPTIONAL_DEP_PACKAGE_NAME}`_ during the step
`${PACKAGE_NAME}_ENABLE_${UPSTREAM_PACKAGE_NAME}`_ during the step
"Adjust package and TPLs enables and disables" in `Full Processing of
TriBITS Project Files`_. And tweaking this variable after that must be
done carefully as described in `How to tweak downstream TriBITS "ENABLE"
Expand Down

0 comments on commit 2dfb4b4

Please sign in to comment.