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: Improve cmake README and INSTALL docs #1448

Closed
wants to merge 5 commits into from
Closed

doc: Improve cmake README and INSTALL docs #1448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
00bd4d8
Improve cmake README and INSTALL docs
ChihweiLHBird Jul 16, 2024
745c0f0
Update INSTALL.md
ChihweiLHBird Jul 18, 2024
eac23cd
Update cmake/README.md
ChihweiLHBird Jul 18, 2024
39597d9
Replace repo_root with onetbb_repo_directory, rephrase cmake configur…
ChihweiLHBird Jul 18, 2024
534a01b
Update README.md
ChihweiLHBird Jul 22, 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
14 changes: 8 additions & 6 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@

## Configure oneTBB

At the command prompt, type:
```
cmake <options> <repo_root>
From the build directory, run:

```bash
cmake [options] <onetbb_repo_directory>
```

You may want to use some additional options for configuration:
Expand All @@ -25,8 +26,9 @@ You may want to use some additional options for configuration:
## Build oneTBB

To build the system, run:
```
cmake --build . <options>

```bash
cmake --build . [options]
```

Some useful build options:
Expand Down Expand Up @@ -73,7 +75,7 @@ Simple packaging using CPack is supported.
The following commands allow you to create a simple portable package that includes header files, libraries, and integration files for CMake:

```bash
cmake <options> ..
cmake [options] ..
cpack
```

Expand Down
8 changes: 5 additions & 3 deletions cmake/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ TBB_BUILD_APPLE_FRAMEWORKS - Enable the Apple* frameworks instead of dylibs, onl

### Preparation

To perform an out-of-source build, create a build directory and go there:
To perform an out-of-source build, create a build directory in an arbitrary location outside the oneTBB source directory and go there:

```bash
mkdir /tmp/my-build
Expand All @@ -35,8 +35,10 @@ cd /tmp/my-build

### Configure

From the build directory, to generate a build system, run:

```bash
cmake <options> <repo_root>
cmake [options] <onetbb_repo_directory>
```

Some useful options:
Expand All @@ -47,7 +49,7 @@ Some useful options:

> **_TIP:_** It is recommended to install the HWLOC* library. See [oneTBB documentation](https://oneapi-src.github.io/oneTBB/GSG/next_steps.html#hybrid-cpu-and-numa-support) for details.

The TBBbind library has three versions: `tbbbind`, `tbbbind_2_0`, and `tbbbind_2_5`. Each of these versions is linked with the corresponding HWLOC* library version:
The TBBbind library has three versions: `tbbbind`, `tbbbind_2_0`, and `tbbbind_2_5`. Each of these versions is linked with the corresponding HWLOC* library version:
- `tbbbind` links with `HWLOC 1.11.x`
- `tbbbind_2_0` links with `HWLOC 2.1–2.4`
- `tbbbind_2_5` links with `HWLOC 2.5` and later
Expand Down
Loading