Skip to content

Commit 6dd85da

Browse files
committed
Update the Target Description web page
- Update the Rust target document parts. Signed-off-by: Chanhee Lee <[email protected]>
1 parent 4783c7d commit 6dd85da

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/reference/target-declaration.mdx

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -380,10 +380,10 @@ This option takes a path as string argument to a folder containing an alternativ
380380
<ShowIf c py ts>
381381
This target does not support the `export-dependency-graph` target option.
382382
</ShowIf>
383-
<ShowIf cpp rs>
383+
<ShowIf cpp>
384384
This parameter takes arguments `true` or `false` to specify whether the compiled binary will export its internal dependency graph as a dot graph when executed. This is a debugging utility.
385385
<ShowOnly rs>
386-
If a [CLI](#command-line-arguments) is generated, the target property is ignored, and the user should instead use the `--export-graph` flag of the generated program.
386+
This feature works when a [CLI](#command-line-arguments) option is enabled and the user use the `--export-graph` flag of the generated program.
387387
</ShowOnly>
388388
</ShowIf>
389389
</ShowIfs>
@@ -477,10 +477,10 @@ The `logging` option is one of `ERROR`, `WARN`, `INFO`, `LOG` or `DEBUG`. It spe
477477
## no-compile
478478

479479
<ShowIfs>
480-
<ShowIf ts rs >
480+
<ShowIf ts>
481481
This target does not support the `no-compile` target option.
482482
</ShowIf>
483-
<ShowIf c cpp py>
483+
<ShowIf c cpp py rs>
484484
If true, then do not invoke a target language compiler nor cmake. Just generate code.
485485
</ShowIf>
486486
</ShowIfs>
@@ -541,12 +541,12 @@ This specifies a set of Rust modules in the generated project. See [Linking supp
541541
## scheduler
542542

543543
<ShowIfs>
544-
<ShowIf c cpp py ts >
544+
<ShowIf c cpp py rs ts >
545545
This target does not support the `scheduler` target option.
546546
</ShowIf>
547-
<ShowIf rs>
547+
{<ShowIf>
548548
This specifies the scheduler to use. See[Target Language Details](<../reference/target-language-details.mdx#scheduler-target-property>).
549-
</ShowIf>
549+
</ShowIf>}
550550
</ShowIfs>
551551

552552
## single-file-project
@@ -556,7 +556,8 @@ This specifies the scheduler to use. See[Target Language Details](<../reference/
556556
This target does not support the `single-file-project` target option.
557557
</ShowIf>
558558
<ShowIf rs>
559-
If true, enables [single-file project layout](#single-file-layout).
559+
{If true, enables [single-file project layout](#single-file-layout).}
560+
If true, only main.rs is generated instead of multiple rust source files.
560561
</ShowIf>
561562
</ShowIfs>
562563

@@ -732,7 +733,7 @@ The generated executable may feature a command-line interface (CLI), if it uses
732733
- `--timeout <time value>`: override the default timeout mentioned as a target property. The syntax for times is just like the LF one (e.g. `1msec`, `"2 seconds"`).
733734
- `--workers <number>`: override the default worker count mentioned as a target property. This option is **ignored** unless the runtime crate has been built with the feature `parallel-runtime`.
734735
- `--export-graph`: export the dependency graph (corresponds to `export-dependency-graph` target property). This is a flag, i.e., absent means false, present means true. This means the value of the target property is ignored and not used as default.
735-
- `--log-level`: corresponds to the `logging` target property, but note that the levels have different meanings, and the target property is ignored. See [Logging levels](#logging-levels).
736+
{- `--log-level`: corresponds to the `logging` target property, but note that the levels have different meanings, and the target property is ignored. See [Logging levels](#logging-levels).}
736737
- parameters of the main reactor are translated to CLI parameters.
737738
- Each LF parameter named `param` corresponds to a CLI parameter named `--main-param`. Underscores in the LF parameter name are replaced by hyphens.
738739
- The type of each parameters must implement the trait [`FromStr`](https://doc.rust-lang.org/std/str/trait.FromStr.html).

0 commit comments

Comments
 (0)