Skip to content

Update reference docs to reflect code default#633

Merged
bartlettroscoe merged 3 commits intoTriBITSPub:masterfrom
sebrowne:master
Apr 16, 2025
Merged

Update reference docs to reflect code default#633
bartlettroscoe merged 3 commits intoTriBITSPub:masterfrom
sebrowne:master

Conversation

@sebrowne
Copy link
Copy Markdown
Contributor

When investigating some behavior in Trilinos, I used the documentation to ascertain the default value of ${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES, and determined it to be inconsistent with the "real" setting. Fix that here.

Signed-off-by: Samuel E. Browne <sebrown@sandia.gov>
@bartlettroscoe
Copy link
Copy Markdown
Member

@sebrowne, it appears you are correct:

set(${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES_DEFAULT OFF)

It seems the default got changed in the commit ec1d0a2 (allowing an override) but the documentation did not get updated correctly somehow and may have even been added incorrectly in commit d2214df.

This explains why there is a configure error in the first sentence.

This documentation block is well linked, but it might as well be more
self-contained.

Signed-off-by: Roscoe A. Bartlett <rabartl@sandia.gov>
Copy link
Copy Markdown
Member

@bartlettroscoe bartlettroscoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the text to make the context for the configure error more clear.

@bartlettroscoe
Copy link
Copy Markdown
Member

@sebrowne, what was the scenario where you hit this situation?

IMHO, automated testing processes should have this set to ${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES=ON as it makes them much more robust. (That was our experience with CASL VERA.)

@sebrowne
Copy link
Copy Markdown
Contributor Author

Here's the linked PR where I repair what is wrong in Trilinos:

trilinos/Trilinos#13991

It was exactly as you said, but we were sometimes setting it and sometimes not. Whether it should be set or unset long-term is a matter for future discussion, but we intend to be setting it on all CI configurations at the moment.

@bartlettroscoe
Copy link
Copy Markdown
Member

@sebrowne, I don't see where ${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES=ON is being set in:

https://github.com/trilinos/Trilinos/pull/13991/files

?

@bartlettroscoe bartlettroscoe merged commit 3e44c31 into TriBITSPub:master Apr 16, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants