Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,16 +102,16 @@ $ ninja install

### Build Options

#### Release build
#### Release build (default)

```bash
$ meson setup <name_of_build_dir> --buildtype=release
```

#### Debug build (default)
#### Debug build

```bash
$ meson setup <name_of_build_dir>
$ meson setup <name_of_build_dir> --buildtype=debug
```

#### NIXL-specific build options
Expand Down Expand Up @@ -169,7 +169,7 @@ For Python examples, see [examples/python/](examples/python/).
### Rust Bindings
#### Build
- Use `-Drust=true` meson option to build rust bindings.
- Use `-Ddebug=false` for a release build.
- Use `--buildtype=debug` for a debug build (default is release).
- Or build manually:
```bash
$ cargo build --release
Expand Down
2 changes: 1 addition & 1 deletion meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
# limitations under the License.

project('nixl', 'CPP', version: '0.6.1',
default_options: ['buildtype=debug',
default_options: ['buildtype=release',
'werror=true',
'cpp_std=c++17',
'prefix=/opt/nvidia/nvda_nixl'],
Expand Down
4 changes: 2 additions & 2 deletions src/plugins/gpunetio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,5 @@ NIXL bench also has the option to specify the DOCA GPUNetIO backend. An example

## Caveats

By default NIXL is built with `buildtype=debug` option. This is ok for correctness and debugging.
To run for performace (e.g. with NIXL bench) t's hightly recommended to build NIXL with `buildtype=release`.
To run for performace (e.g. with NIXL bench) it's highly recommended to build NIXL with `buildtype=release`.
For debugging purposes, NIXL can be built with `buildtype=debug`.
Loading