Skip to content

Commit

Permalink
fixes docs for config files (#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
christophkloeffel authored Aug 6, 2024
1 parent d59f1ba commit 1b6beca
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/config_files.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ For example, here we declare that requirements are the top-level
requirements.

```
implementation "Requirements" {
requirements "Requirements" {
source: "trlc.lobster";
}
Expand Down Expand Up @@ -106,7 +106,7 @@ configuration can help here:


```
implementation "Requirements" {
requirements "Requirements" {
source: "trlc.lobster";
requires: "Code";
requires: "Unit Test" or "Formal Proof";
Expand All @@ -116,6 +116,10 @@ implementation "Requirements" {
Now an item is considered to be completely traced if it has both a
link to code, and either a link to a test or a link to a proof.

**Note:**
Don't forget that the `trace to` configuration is always mandatory.
You cannot build links with a configuration that uses only `requires`.

# Examples

A simple example that just links SIMULINK models to requirements
Expand Down

0 comments on commit 1b6beca

Please sign in to comment.