From 82bfc7e09c7db5ca559b25428ac73c58711a4a19 Mon Sep 17 00:00:00 2001 From: Christian Menard Date: Tue, 5 Mar 2024 10:52:13 +0100 Subject: [PATCH 1/2] Fix description of the build-type property, default to debug --- docs/reference/target-declaration.mdx | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/docs/reference/target-declaration.mdx b/docs/reference/target-declaration.mdx index 6c84a7f51..0dfe5bb55 100644 --- a/docs/reference/target-declaration.mdx +++ b/docs/reference/target-declaration.mdx @@ -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. @@ -56,7 +56,7 @@ c={ `target C { auth: build: , - build-type: , + build-type: , cmake: , cmake-include: , compiler: , @@ -74,7 +74,7 @@ c={ } cpp={ `target Cpp { - build-type: , + build-type: , cmake-include: , external-runtime-path: , export-dependency-graph , @@ -221,25 +221,15 @@ This target does not currently support the `build` target option. This target does not currently support the `build-type` target option. - -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`. - - -This parameter works with `cmake` to specify how to compile the code. The following options are supported: + +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`. From 3de8d5cb9a776b68a293dd54f0a311e8b2aba00b Mon Sep 17 00:00:00 2001 From: Christian Menard Date: Wed, 6 Mar 2024 13:31:17 +0100 Subject: [PATCH 2/2] apply same change to the 0.6.0 version --- .../reference/target-declaration.mdx | 26 ++++++------------- 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/versioned_docs/version-0.6.0/reference/target-declaration.mdx b/versioned_docs/version-0.6.0/reference/target-declaration.mdx index 4f00a18a5..edc9c319e 100644 --- a/versioned_docs/version-0.6.0/reference/target-declaration.mdx +++ b/versioned_docs/version-0.6.0/reference/target-declaration.mdx @@ -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. @@ -56,7 +56,7 @@ c={ `target C { auth: build: , - build-type: , + build-type: , cmake: , cmake-include: , compiler: , @@ -74,7 +74,7 @@ c={ } cpp={ `target Cpp { - build-type: , + build-type: , cmake-include: , external-runtime-path: , export-dependency-graph , @@ -221,25 +221,15 @@ This target does not currently support the `build` target option. This target does not currently support the `build-type` target option. - -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`. - - -This parameter works with `cmake` to specify how to compile the code. The following options are supported: + +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`.