Skip to content

Commit dc55b7b

Browse files
authored
Merge pull request #303 from lf-lang/fix-links
Fix broken links
2 parents 3c5c1d9 + 4ead6a7 commit dc55b7b

File tree

72 files changed

+337
-341
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+337
-341
lines changed

docs/developer/developer-eclipse-setup-with-oomph.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Hello World.
109109

110110
This should print "Hello World".
111111

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.
113113

114114
## Working on the Lingua-Franca Compiler
115115

docs/embedded/arduino.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Arduino
33
description: Developing LF Programs on Arduino.
44
---
55

6-
# Overview
6+
## Overview
77

88
To run Lingua Franca on an Arduino-compatible microcontroller, you can use the
99
`C` target with the `platform` target property set to `arduino`. The Lingua
@@ -13,7 +13,7 @@ To flash the compiled sketch onto a board, you need specify a Fully Qualified
1313
Board Name (FQBN) as well as the port to which your board is connected. On this
1414
page, we explain exactly how to do this.
1515

16-
## Prerequisites
16+
### Prerequisites
1717

1818
- You need a development system that runs on macOS or Linux (there is currently no Windows support).
1919
- [Arduino CLI](https://arduino.github.io/arduino-cli/) must be installed on your development system. Confirm that your installation works by running:
@@ -22,7 +22,7 @@ page, we explain exactly how to do this.
2222
arduino-cli version
2323
```
2424

25-
# Writing a simple Arduino Program
25+
## Writing a simple Arduino Program
2626

2727
The most basic Arduino program (Blink) can be defined in LF like so:
2828

@@ -56,7 +56,7 @@ can invoke Arduino library functions, just like one would do in the definition
5656
of an Arduino `loop()`. For any setup that might be needed at the beginning of
5757
execution, a reaction triggered by the built-in `startup` trigger can be used.
5858

59-
## Platform Options
59+
### Platform Options
6060

6161
The `platform` property can also be used so specify more details. Along with `name: "arduino"`,
6262
you can specify which `board`, `port`, and `baud-rate` you are using. If you want the program
@@ -77,14 +77,14 @@ target C {
7777

7878
The `board` is necessary for [building](#building) and the `port` is necessary for [flashing](#flashing).
7979

80-
### Baud rate of the serial port
80+
#### Baud rate of the serial port
8181

8282
All Arduino boards have at least one serial port (also known as a UART or
8383
USART), and some have several. By default, Lingua Franca will assume a default
8484
baud rate of 9600. This parameter is tunable by adjusting the `baud-rate`
8585
parameter in platform options.
8686

87-
# Building
87+
## Building
8888

8989
In order to have `arduino-cli` compile the generated sketch file, a `board` must
9090
be specified. If no `board` is set, `lfc` will run in `no-compile` mode, meaning
@@ -112,7 +112,7 @@ If you specify your FQBN under `board` in the `platform` target property, `lfc`
112112
- for threaded programs (`arduino:mbed` boards), run:
113113
`arduino-cli compile -b [FQBN] --build-property compiler.c.extra_flags="-DPLATFORM_ARDUINO -DINITIAL_EVENT_QUEUE_SIZE=10 -DINITIAL_REACT_QUEUE_SIZE=10" --build-property compiler.cpp.extra_flags="-DPLATFORM_ARDUINO -DINITIAL_EVENT_QUEUE_SIZE=10 -DINITIAL_REACT_QUEUE_SIZE=10"`
114114

115-
# Flashing
115+
## Flashing
116116

117117
Arduino's can be flashed via USB. To find the port oto which your device is connected, run the following command:
118118

docs/reference/target-declaration.mdx

+3-4
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,8 @@ A target specification may have optional parameters, the names and values of whi
2828
- [**build-type**](#build-type): One of Debug (the default), Release, RelWithDebInfo and MinSizeRel.
2929
- [**cargo-dependencies**](#cargo-dependencies): (Rust only) list of dependencies to include in the generated Cargo.toml file.
3030
- [**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.
3232
- [**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.
3433
- [**docker**](#docker): A boolean to generate a Dockerfile.
3534
- [**external-runtime-path**](#external-runtime-path): Specify a pre-compiled external runtime library located to link to instead of the default.
3635
- [**export-dependency-graph**](#export-dependency-graph): To export the reaction dependency graph as a dot graph (for debugging).
@@ -646,7 +645,7 @@ Any errors in command-line arguments result in printing the above information. T
646645

647646
### Custom Command-Line Arguments
648647

649-
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).
650649

651650
Note: Custom arguments may not have the same names as standard arguments like `timeout` or `keepalive`.
652651

@@ -736,7 +735,7 @@ The generated C++ program understands the following command-line arguments, each
736735
- `-w, --workers <n>`: Use n worker threads for executing reactions.
737736
- `--help`: Print the above information.
738737

739-
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.
740739
</ShowIf>
741740
<ShowIf py>
742741
The Python target does not currently support any command-line arguments. You must specify properties as target parameters.

0 commit comments

Comments
 (0)