You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/developer/developer-eclipse-setup-with-oomph.mdx
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -109,7 +109,7 @@ Hello World.
109
109
110
110
This should print "Hello World".
111
111
112
-
We strongly recommend browsing the system tests, which provide a concise overview of the capabilities of Lingua Franca. You can set up a project in the IDE for this using [these instructions](<../developer/regression-tests.mdx#browsing-and-editing-examples-in-the-lf-ide>).
112
+
We strongly recommend browsing the [integration tests](regression-tests.mdx), which provide a concise overview of the capabilities of Lingua Franca.
Copy file name to clipboardExpand all lines: docs/introduction.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -25,4 +25,4 @@ The reactor-oriented programming paradigm is informally described via the follow
25
25
8._Concurrency_ — Dependencies between reactions are explicitly declared in a Lingua Franca program, and reactions that are not dependent on one another can be executed in parallel on a multi-core machine. If the target provides a support for federated execution, then execution can also be distributed across networks.
26
26
27
27
## Getting Started
28
-
To get started with Lingua Franca, [set up a development environment](./installation.md) and learn how to write [a first reactor](./writing-reactors/a-first-reactor.mdx). There are also a number of useful [tutorial videos](./tutorial-videos.mdx) available.
28
+
To get started with Lingua Franca, [set up a development environment](./installation.md) and learn how to write [a first reactor](./writing-reactors/a-first-reactor.mdx). There are also a number of potentially useful [videos](./videos.mdx) available.
Copy file name to clipboardExpand all lines: docs/reference/target-declaration.mdx
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -28,9 +28,8 @@ A target specification may have optional parameters, the names and values of whi
28
28
-[**build-type**](#build-type): One of Debug (the default), Release, RelWithDebInfo and MinSizeRel.
29
29
-[**cargo-dependencies**](#cargo-dependencies): (Rust only) list of dependencies to include in the generated Cargo.toml file.
30
30
-[**cargo-features**](#cargo-features): (Rust only) List of string names of features to include.
31
-
-[**cmake-include**](#cmake): List of paths to cmake files to guide compilation.
31
+
-[**cmake-include**](#cmake-include): List of paths to cmake files to guide compilation.
32
32
-[**compiler**](#compiler): A string giving the name of the target language compiler to use.
33
-
-[**compiler-flags**](#compiler-flags): An arrays of strings giving options to be passed to the target compiler.
34
33
-[**docker**](#docker): A boolean to generate a Dockerfile.
35
34
-[**external-runtime-path**](#external-runtime-path): Specify a pre-compiled external runtime library located to link to instead of the default.
36
35
-[**export-dependency-graph**](#export-dependency-graph): To export the reaction dependency graph as a dot graph (for debugging).
@@ -44,7 +43,7 @@ A target specification may have optional parameters, the names and values of whi
44
43
-[**runtime-version**](#runtime-version): Specify which version of the runtime system to use.
45
44
-[**rust-include**](#rust-include): (Rust only) A set of Rust modules in the generated project.
46
45
-[**scheduler**](#scheduler): (C only) Specification of the scheduler to use.
47
-
-[**single-file-project**](#single-file-project): (Rust only) If true, enables [single-file project layout](#single-file-layout).
46
+
-[**single-file-project**](#single-file-project): (Rust only) If true, enables [single-file project layout](target-language-details/?target-languages=rs#file-layout).
48
47
-[**single-threaded**](#single-threaded): Specify to not use multithreading.
49
48
-[**timeout**](#timeout): A time value (with units) specifying the logical stop time of execution. See [Termination](../writing-reactors/termination.mdx).
50
49
-[**workers**](#workers): If using multiple threads, how many worker threads to create.
@@ -161,7 +160,7 @@ A command to execute after code generation instead of the default compile comman
161
160
-`LF_CURRENT_WORKING_DIRECTORY`: The directory in which the command is invoked.
162
161
-`LF_SOURCE_DIRECTORY`: The directory containing the .lf file being compiled.
163
162
-`LF_PACKAGE_DIRECTORY`: The directory for the root of the project or package (normally the directory above the `src` directory).
164
-
-`LF_SOURCE_GEN_DIRECTORY`: The directory in which generated files are placed.
163
+
-`LF_SOURCE_GEN_DIRECTORY`: The directory in which generated files and any files in the [files](#files) target directive are placed.
165
164
-`LF_BIN_DIRECTORY`: The directory into which to put binaries.
166
165
167
166
The command will be executed in the same directory as the `.lf` file being compiled. For example, if you specify
@@ -400,6 +399,7 @@ This target does not support the `files` option.
400
399
</ShowIf>
401
400
<ShowIfcpy>
402
401
The `files` target parameter specifies array of files or directories to be copied to the directory that contains the generated sources.
402
+
The full path to that directory is available in C code via the `LF_SOURCE_GEN_DIRECTORY` macro.
403
403
404
404
<ShowOnlyc>
405
405
```lf-c
@@ -645,7 +645,7 @@ Any errors in command-line arguments result in printing the above information. T
645
645
646
646
### Custom Command-Line Arguments
647
647
648
-
User-defined command-line arguments may be created by giving the main reactor [parameters](#using-parameters). Assigning the main reactor a parameter of type `string`, `number`, `boolean`, or `time` will add an argument with corresponding name and type to the generated program's command-line-interface. Custom arguments will also appear in the generated program's usage guide (from the `--help` option). If the generated program is executed with a value specified for a custom command-line argument, that value will override the default value for the corresponding parameter. Arguments typed `string`, `number`, and `boolean` are parsed in the expected way, but `time` arguments must be specified on the command line like the `--timeout` property as `'<duration> <units>'` (in quotes).
648
+
User-defined command-line arguments may be created by giving the main reactor [parameters](../writing-reactors/parameters-and-state-variables.mdx#parameter-declaration). Assigning the main reactor a parameter of type `string`, `number`, `boolean`, or `time` will add an argument with corresponding name and type to the generated program's command-line-interface. Custom arguments will also appear in the generated program's usage guide (from the `--help` option). If the generated program is executed with a value specified for a custom command-line argument, that value will override the default value for the corresponding parameter. Arguments typed `string`, `number`, and `boolean` are parsed in the expected way, but `time` arguments must be specified on the command line like the `--timeout` property as `'<duration> <units>'` (in quotes).
649
649
650
650
Note: Custom arguments may not have the same names as standard arguments like `timeout` or `keepalive`.
651
651
@@ -735,7 +735,7 @@ The generated C++ program understands the following command-line arguments, each
735
735
-`-w, --workers <n>`: Use n worker threads for executing reactions.
736
736
-`--help`: Print the above information.
737
737
738
-
If the main reactor declares parameters, these parameters will appear as additional CLI options that can be specified when invoking the binary (see [Using Parameters](#using-parameters)).
738
+
If the main reactor declares parameters, these parameters will appear as additional CLI options that can be specified when invoking the binary.
739
739
</ShowIf>
740
740
<ShowIfpy>
741
741
The Python target does not currently support any command-line arguments. You must specify properties as target parameters.
0 commit comments