Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc updates 2024-01-31 #602

Merged
merged 2 commits into from
Jan 31, 2024
Merged

Doc updates 2024-01-31 #602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2dfb4b4
Doc: Fix var renaming from OPTIONAL_DEP_PACKAGE_NAME to UPSTREAM_PACK…
bartlettroscoe Jan 31, 2024
a5bbd93
Doc: Small updates to tribits_package_define_dependencies() document…
bartlettroscoe Jan 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions tribits/core/package_arch/TribitsPackageDefineDependencies.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,9 @@ include(TribitsGeneralMacros)
# additional testing of some type. (Add these to
# ``TEST_OPTIONAL_PACKAGES`` instead.)
#
# NOTE: The ``XXX_TPLS`` arguments/lists are **deprecated**. At the package
# level, there is no distinction between upstream internal and external
# packages (i.e. TPLs) so all upstream package dependencies can (and should)
# NOTE: The above ``XXX_TPLS`` arguments/lists are **deprecated**. At the
# package level, there is no distinction between upstream internal and
# external packages/TPLs, so all upstream package dependencies can (and should)
# be listed in the ``XXX_PACKAGES`` arguments/lists. (There is no change in
# behavior listing upstream packages in ``XXX_PACKAGES`` or the ``XXX_TPLS``
# arguments/lists.)
Expand All @@ -155,8 +155,8 @@ include(TribitsGeneralMacros)
# ``TEST_OPTIONAL_PACKAGES``.
#
# The upstream dependencies within a single list do not need to be listed in
# any order. For example if ``PKG2`` depends on ``PKG1``, and this given
# package depends on both, then one can list::
# any particular order. For example, if ``PKG2`` depends on ``PKG1``, and
# this given package depends on both, then one can list the dependencies as::
#
# LIB_REQUIRED_PACKAGES PKG2 PKG1
#
Expand Down
24 changes: 12 additions & 12 deletions tribits/doc/guides/TribitsGuidesBody.rst
View file
Open in desktop
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
Loading