Skip to content

Commit

Permalink
Fix description of the build-type property, default to debug
Browse files Browse the repository at this point in the history
  • Loading branch information
cmnrd committed Mar 6, 2024
1 parent d528bad commit 82bfc7e
Showing 1 changed file with 8 additions and 18 deletions.
26 changes: 8 additions & 18 deletions docs/reference/target-declaration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ A target specification may have optional parameters, the names and values of whi

- [**auth**](#auth): A boolean specifying to apply authorization between RTI and federates when federated execution.
- [**build**](#build): A command to execute after code generation instead of the default compile command.
- [**build-type**](#build-type): One of Release (the default), Debug, RelWithDebInfo and MinSizeRel.
- [**build-type**](#build-type): One of Debug (the default), Release, RelWithDebInfo and MinSizeRel.
- [**cargo-dependencies**](#cargo-dependencies): (Rust only) list of dependencies to include in the generated Cargo.toml file.
- [**cargo-features**](#cargo-features): (Rust only) List of string names of features to include.
- [**cmake**](#cmake): Whether to use cmake for building.
Expand Down Expand Up @@ -56,7 +56,7 @@ c={
`target C {
auth: <true or false>
build: <string>,
build-type: <Release, Debug, RelWithDebInfo, or MinSizeRel>,
build-type: <Debug, Release, RelWithDebInfo, or MinSizeRel>,
cmake: <true or false>,
cmake-include: <string or list of strings>,
compiler: <string>,
Expand All @@ -74,7 +74,7 @@ c={
}
cpp={
`target Cpp {
build-type: <Release, Debug, RelWithDebInfo, or MinSizeRel>,
build-type: <Debug, Release, RelWithDebInfo, or MinSizeRel>,
cmake-include: <string or list of strings>,
external-runtime-path: <string>,
export-dependency-graph <true or false>,
Expand Down Expand Up @@ -221,25 +221,15 @@ This target does not currently support the `build` target option.
<ShowIf ts py>
This target does not currently support the `build-type` target option.
</ShowIf>
<ShowIf rs>
This parameter works with `cargo` to specify how to compile the code. The following options are supported:

- `Release`: Optimization is turned on and debug information is missing.
- `Debug`: Debug information is included in the executable.
- `RelWithDebInfo`: Optimization with debug information.
- `MinSizeRel`: Optimize for smallest size.

This defaults to `Release`.
</ShowIf>
<ShowIf c cpp>
This parameter works with `cmake` to specify how to compile the code. The following options are supported:
<ShowIf rs c cpp>
This parameter specifies how to compile the code. The following options are supported:

- `Release`: Optimization is turned on and debug information is missing.
- `Debug`: Debug information is included in the executable.
- `Debug`: Optimization is disabled and debug information is included in the executable.
- `Release`: Optimization is enabled and debug information is missing.
- `RelWithDebInfo`: Optimization with debug information.
- `MinSizeRel`: Optimize for smallest size.

This defaults to `Release`.
This defaults to `Debug`.
</ShowIf>
</ShowIfs>

Expand Down

0 comments on commit 82bfc7e

Please sign in to comment.