ogma-cli: Present conversion options based on backends

[ivanperez-keera]

Description

The sections of the README list conversion of FRET files first, then the cFS command, then the C structs conversion, then the ROS command.

This presentation is partly misleading, since FRET commands can also be fed to some backends.

A better way to present the information would be to list the backends available (conversion to Copilot/stand-alone C, conversion to cFS, conversion to ROS, conversion to FPrime), giving examples of the input formats.

Type

• Bug: presentation of elements in documentation makes understanding harder.

Additional context

None.

Requester

• Ivan Perez

Method to check presence of bug

The issue is with the documentation. There is no good, simple automated way to check that it is correct.

Because it's not a programming issue, visual inspection is OK.

Expected result

The README file is structured around the backends and features, rather than the inputs.

Desired result

The README file is structured around the backends and features, rather than the inputs.

Proposed solution

Lay out elements in README as follows:

• Describe purpose and intro.
• Describe backends, using the frontends supported as examples.

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

Fix assigned to: @ivanperez-keera.

[ivanperez-keera]

Implementor: Solution implemented, review requested.

[ivanperez-keera]

Change Manager: Verified that:

• Solution is implemented:
  • The code proposed compiles and passes all tests. Details:
    Docker image:

    FROM ubuntu:trusty
    
    RUN apt-get update
    
    RUN apt-get install --yes software-properties-common
    RUN add-apt-repository ppa:hvr/ghc
    RUN apt-get update
    
    RUN apt-get install --yes ghc-8.6.5 cabal-install-2.4
    RUN apt-get install --yes libz-dev
    
    ENV PATH=/opt/ghc/8.6.5/bin:/opt/cabal/2.4/bin:$PWD/.cabal-sandbox/bin:$PATH
    
    RUN cabal update
    RUN cabal v1-sandbox init
    RUN cabal v1-install alex happy
    RUN apt-get install --yes git
    
    # We install the application first and then test it, in case any tests need to
    # run the tool.
    CMD git clone $REPO && \
        cd $NAME && \
        git checkout $COMMIT && \
        cd .. && \
        cabal v1-install $NAME/$PAT**/ --enable-tests && \
        cabal v1-install $NAME/$PAT**/ --enable-tests --run-tests -j1

    Command:

    $ docker run -e "REPO=https://github.com/ivanperez-keera/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=41ef5b5f31fe4be8de06b4b2c8935eb10e0f1c01" -it ogma-test

  • The solution proposed fixes the issues described.
    The change is to the README, so the solution is checked by visual inspection. The README is not focused on the targets and functionalities provided by Ogma.
• Implementation is documented. Details:
  The update is to to the documentation.
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  No examples affected.
• Required version bumps are evaluated. Details:
  No bump needed; bump executed.

[ivanperez-keera]

Change Manager: Implementation ready to be merged.