Skip to content

Commit 3e44c31

Browse files
Merge pull request #633 from sebrowne/master
Update reference docs to reflect code default
2 parents 06c8e1b + 6063f1e commit 3e44c31

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

tribits/doc/guides/TribitsCoreDetailedReference.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -289,15 +289,17 @@ These options are described below.
289289

290290
**${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES**
291291

292-
If `${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES=ON`_ (the TriBITS
293-
default value), then any explicitly enabled packages that have disabled
294-
`upstream`_ required packages or TPLs will be disabled. If
295-
`${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES=OFF`_, then an
296-
configure error will occur. For more details also see
297-
`TribitsBuildReference`_ and `Disables trump enables where there is a
298-
conflict`_. A project can define a different default value by setting::
292+
If `${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES=OFF`_ (the TriBITS
293+
default value), then if a downstream package is explicitly enabled but one
294+
of its `upstream`_ required packages are disabled, then a configure error
295+
will occur. Otherwise, if
296+
`${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES=ON`_, then any
297+
explicitly enabled packages that have disabled upstream required packages
298+
will be disabled. For more details, also see `TribitsBuildReference`_ and
299+
`Disables trump enables where there is a conflict`_. A project can define a
300+
different default value by setting::
299301
300-
set(${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES_DEFAULT FALSE)
302+
set(${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES_DEFAULT TRUE)
301303

302304
.. _${PROJECT_NAME}_ELEVATE_ST_TO_PT:
303305

0 commit comments

Comments
 (0)