Update README.md with TBB_FIND_PACKAGE variable info #1471
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
isaevil
requested changes
Aug 7, 2024
cmake/README.md
Outdated
| @@ -10,6 +10,7 @@ TBB_SANITIZE:STRING - Sanitizer parameter, passed to compiler/linker | |||
| TBB_SIGNTOOL:FILEPATH - Tool for digital signing, used in post-install step for libraries if provided. | |||
| TBB_SIGNTOOL_ARGS:STRING - Additional arguments for TBB_SIGNTOOL, used if TBB_SIGNTOOL is set. | |||
| TBB_BUILD:BOOL - Enable Intel(R) oneAPI Threading Building Blocks (oneTBB) build (ON by default) | |||
| DTBB_FIND_PACKAGE - Enable search for external oneTBB using find_package instead of build from sources (OFF by default) | |||
There was a problem hiding this comment.
Suggested change
| DTBB_FIND_PACKAGE - Enable search for external oneTBB using find_package instead of build from sources (OFF by default) | |
| TBB_FIND_PACKAGE - Enable search for external oneTBB using find_package instead of build from sources (OFF by default) |
There was a problem hiding this comment.
Updated the variable.
cmake/README.md
Outdated
Comment on lines
238
to
241
| 1. Set TBB_FIND_PACKAGE=ON | ||
| 2. Let CMake know where to search for TBBConfig, e.g. specify the location of ``TBBConfig.cmake`` in `TBB_DIR` (for more details about search paths, see [find_package](https://cmake.org/cmake/help/latest/command/find_package.html)). | ||
| 3. Use [find_package](https://cmake.org/cmake/help/latest/command/find_package.html) to find oneTBB. | ||
| 4. Use provided variables and/or imported targets (described below) to work with the found oneTBB. |
There was a problem hiding this comment.
These are the steps for using TBB in different projects using find_package functionality. No need to update anything here.
There was a problem hiding this comment.
Removed the Set TBB_FIND_PACKAGE=ON from instructions.
cmake/README.md
Outdated
| @@ -268,7 +270,7 @@ Variable | Description | |||
| `TBB_IMPORTED_TARGETS` | All created oneTBB imported targets (not supported for builds from source code) | |||
|
|
|||
| Starting from [oneTBB 2021.1](https://github.com/oneapi-src/oneTBB/releases/tag/v2021.1), GitHub* release TBBConfig files in the binary packages are located under `<tbb-root>/lib/cmake/TBB`. | |||
| For example, `TBB_DIR` should be set to `<tbb-root>/lib/cmake/TBB`. | |||
| For example, 'TBB_FIND_PACKAGE' should be set to ON and `TBB_DIR` should be set to `<tbb-root>/lib/cmake/TBB`. | |||
There was a problem hiding this comment.
Removed TBB_FIND_PACKAGE from the instructions.
kboyarinov
pushed a commit
that referenced
this pull request
Oct 1, 2024
* Update README.md with TBB_FIND_PACKAGE variable info
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add a comprehensive description of proposed changes
Fixes # - issue number(s) if exists
Type of change
Choose one or multiple, leave empty if none of the other choices apply
Add a respective label(s) to PR if you have permissions
Tests
Documentation
Breaks backward compatibility
Notify the following users
List users with
@to send notificationsOther information