Commit 3a15256
committed
Merge branch 'develop-tutorial-diagrams-fix-args' into develop. Close #349.
**Description**
The arguments used to invoke the `diagram` command in the tutorial are
incorrect. Specifically, the tutorial uses arguments `--app-target-dir`
and `--file-format`, while the actual command uses `--target-dir` and
`--input-format`.
**Type**
- Bug: Incorrect steps in tutorial.
**Additional context**
None.
**Requester**
- Ivan Perez.
**Method to check presence of bug**
Executing commands to Ogma in
`ogma-cli/examples/diagram-001-hello-ogma/README.md` results in an
error:
```sh
$ ogma diagram --app-target-dir demo \
--mode calculate \
--input-file ogma-cli/examples/diagram-001-hello-ogma/diagram-copilot.dot \
--file-format dot \
--prop-format literal
Invalid option `--app-target-dir'
Usage: ogma diagram [--target-dir DIR] [--template-dir DIR]
--input-file FILENAME [-f|--input-format FORMAT_NAME]
[-p|--prop-format FORMAT_NAME] [--target-file-name FILENAME]
[--mode MODE] [--state-var NAME] [--input-var NAME]
Generate a monitor from state machine diagram
```
**Expected result**
Following the steps in the tutorial allows users to reproduce the results.
**Solution implemented**
Modify tutorial to use the arguments actually implemented in Ogma.
**Further notes**
None.File tree
2 files changed
+5
-4
lines changed- ogma-cli
- examples/diagram-001-hello-ogma
2 files changed
+5
-4
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| 9 | + | |
9 | 10 | | |
10 | 11 | | |
11 | 12 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | | - | |
| 55 | + | |
56 | 56 | | |
57 | 57 | | |
58 | | - | |
| 58 | + | |
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
| |||
195 | 195 | | |
196 | 196 | | |
197 | 197 | | |
198 | | - | |
| 198 | + | |
199 | 199 | | |
200 | 200 | | |
201 | | - | |
| 201 | + | |
202 | 202 | | |
203 | 203 | | |
204 | 204 | | |
| |||
0 commit comments