`ogma-cli`: Arguments to `diagram` command in tutorial are incorrect

[ivanperez-keera]

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:

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

Desired result

Following the steps in the tutorial allows users to reproduce the results.

Proposed solution

Modify tutorial to use the arguments actually implemented in Ogma.

Further notes

None.

[ivanperez-keera]

Change Manager: Confirmed that the issue exists.

[ivanperez-keera]

Technical Lead: Confirmed that the issue should be addressed.

[ivanperez-keera]

Technical Lead: Issue scheduled for fixing in Ogma 1.13.0.

Fix assigned to: @ivanperez-keera .