Skip to content

Commit 3a15256

Browse files
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.
2 parents 91125ff + a16da73 commit 3a15256

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

ogma-cli/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* Make example file consistent with associated tutorial (#343).
77
* Add syntax information to code blocks in tutorials (#345).
88
* Update installation instructions for Linux, Mac (#347).
9+
* Fix incorrect arguments to `diagram` command in tutorial (#349).
910

1011
## [1.12.0] - 2026-01-21
1112

ogma-cli/examples/diagram-001-hello-ogma/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,10 @@ machine implementations, users need to provide the following information:
5252
An invocation of Ogma's diagram backend may look like the following:
5353

5454
```sh
55-
$ ogma diagram --app-target-dir demo \
55+
$ ogma diagram --target-dir demo \
5656
--mode calculate \
5757
--input-file ogma-cli/examples/diagram-001-hello-ogma/diagram-copilot.dot \
58-
--file-format dot \
58+
--input-format dot \
5959
--prop-format literal
6060
```
6161

@@ -195,10 +195,10 @@ To generate the application from the diagram above, we invoke `ogma` with the
195195
following arguments:
196196

197197
```sh
198-
$ ogma diagram --app-target-dir demo \
198+
$ ogma diagram --target-dir demo \
199199
--prop-format literal \
200200
--mode calculate \
201-
--file-format dot \
201+
--input-format dot \
202202
--input-file ogma-cli/examples/diagram-001-hello-ogma/diagram-copilot.dot
203203
```
204204

0 commit comments

Comments
 (0)