Merge branch 'main' into fix-compiler

Author: cmnrd

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-include**](#cmake): List of paths to cmake files to guide compilation.
@@ -55,7 +55,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-include: <string or list of strings>,
     compiler: <string>,
     compiler-flags: <string or list of strings>,
@@ -72,9 +72,9 @@ c={
 } 
 cpp={
 `target Cpp {
-    build-type: <Release, Debug, RelWithDebInfo, or MinSizeRel>,
-    compiler: <string>,
+    build-type: <Debug, Release, RelWithDebInfo, or MinSizeRel>,
     cmake-include: <string or list of strings>,
+    compiler: <string>,
     external-runtime-path: <string>,
     export-dependency-graph <true or false>,
     fast: <true or false>,
@@ -220,25 +220,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>
 

versioned_docs/version-0.6.0/embedded/zephyr.mdx

@@ -36,31 +36,37 @@ are going to create next.
 git clone https://github.com/lf-lang/lf-west-template lf-zephyr-workspace && cd lf-zephyr-workspace
 ```
 
-2. Setup and activate a virtual environment
+2. Setup the virtual environment
 ```
 python3 -m venv .venv
+```
+
+3. Activate the virtual environment and source Zephyr's environment
+```
 source .venv/bin/activate
+source deps/zephyr/zephyr-env.sh
 ```
 
-3. Install `west`
+4. Install `west`
 ```
 pip3 install west
 ```
 
 Now `west` is installed within a virtual environment. **This environment has to
-be activated every time you want to use west with LF**
+be activated every time you want to use west with LF; use `source env.sh` as a
+shorthand to activate both.**
 
-4. Get the Zephyr source code
+5. Get the Zephyr source code
 ```
 west update
 ```
 
-5. Export CMake packages for Zephyr
+6. Export CMake packages for Zephyr
 ```
 west zephyr-export
 ```
 
-6. Install Python dependencies
+7. Install Python dependencies
 ```
 pip install -r deps/zephyr/scripts/requirements.txt
 ```
@@ -181,7 +187,8 @@ In this guide we have shown how LF Zephyr apps can be developed in a
 approach. When you give `lfc` a LF program with the `platform` target property
 set to `Zephyr`, it will generate a Zephyr project that can be built with
 `west`. For this to work, the environment variable `ZEPHYR_BASE` must be set to
-point to the Zephyr RTOS sources. To demonstrate this, create a simple example
+point to the Zephyr RTOS sources. This is done by sourcing `zephyr-env.sh` at
+the root of the Zephyr repository. To demonstrate this, create a simple example
 program:
 ```
 cat >> LfcCentricZephyr.lf << 'END'
@@ -200,8 +207,7 @@ If `west` is installed in a virtual environment, activate it, and set up the
 environment. Assuming that the template is located at `/home/lf-zephyr-workspace`
 
 ```
-source /home/lf-zephyr-workspace/.venv/bin/activate
-export ZEPHYR_BASE=/home/lf-zephyr-workspace/deps/zephyr
+source /home/lf-zephyr-workspace/env.sh
 lfc LfcCentricZephyr.lf
 ```
 

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-include**](#cmake): List of paths to cmake files to guide compilation.
@@ -55,7 +55,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-include: <string or list of strings>,
     compiler: <string>,
     compiler-flags: <string or list of strings>,
@@ -72,9 +72,9 @@ c={
 } 
 cpp={
 `target Cpp {
-    build-type: <Release, Debug, RelWithDebInfo, or MinSizeRel>,
-    compiler: <string>,
+    build-type: <Debug, Release, RelWithDebInfo, or MinSizeRel>,
     cmake-include: <string or list of strings>,
+    compiler: <string>,
     external-runtime-path: <string>,
     export-dependency-graph <true or false>,
     fast: <true or false>,
@@ -220,25 +220,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>