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.

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

Document support for alternative libs with tribits_tpl_find_include_dirs_and_libraries() REQUIRED_LIBS_NAMES #622

Merged
merged 5 commits into from
Nov 1, 2024

Conversation

bartlettroscoe
Copy link
Member

@bartlettroscoe bartlettroscoe commented Nov 1, 2024

Description

This adds documentation for how to provide a list of alternative lib names with the tribits_tpl_find_include_dirs_and_libraries() argument REQUIRED_LIBS_NAMES. This has been a supported and tested feature for a long time. But amazingly, it was not documented!

This PR was motivated by a question from a Trilinos user about how to update some FindTPL<tplName>.cmake find modules in Trilinos to look for alternative names as well (like look for openblas if you can't find blas).

Instructions to reviewers

See updated documentation. See the rendered updated documentation at:

…IND_VERSION (TriBITSPub#610)

I somehow missed this in the previous commit:

  3e5471d "Change to find_package(Python3), set Python3_EXECUTABLE to PYTHON_EXECUTABLE (TriBITSPub#610)"
  Author: Roscoe A. Bartlett <[email protected]>
  Date:   Thu Oct 3 12:03:52 2024 -0600 (4 weeks ago)

Signed-off-by: Roscoe A. Bartlett <[email protected]>
I just noticed this when looking over this code.

Signed-off-by: Roscoe A. Bartlett <[email protected]>
Signed-off-by: Roscoe A. Bartlett <[email protected]>
I was noticing that there was no hyperlinks to get from the documentation for
FindTPL<tplName>.cmake to these functions and I had to resort to dumb browser
searches.

Signed-off-by: Roscoe A. Bartlett <[email protected]>
…_dirs_and_libraries()

Signed-off-by: Roscoe A. Bartlett <[email protected]>
Copy link
Collaborator

@rabartlett1972 rabartlett1972 left a comment

Choose a reason for hiding this comment

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

Allow merge so we can see the rendered documentation and then do a post-merge review.

@bartlettroscoe bartlettroscoe merged commit 860f3d0 into TriBITSPub:master Nov 1, 2024
6 checks passed
@bartlettroscoe bartlettroscoe deleted the library_names_doc branch November 1, 2024 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

2 participants