ogma-cli: Cabal package description does not list FPrime backend

[ivanperez-keera]

Description

The cabal package description does not list the FPrime backend among the use cases supported.

Type

• Bug: missing backend in documentation.

Additional context

Issue #77 should have included this change.

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 cabal package description mentions that we have an FPrime backend.

Desired result

The cabal package description mentions that we have an FPrime backend.

Proposed solution

Modify cabal package description to list FPrime backend as another supported use case.

Add link to FPrime under "further information".

Further notes

Normally, the addition of new information to the description would be considered a feature. In this case, however, this should have been included as part of the feature that added support for FPrime. It was an oversight not to list this backend also in the cabal description. Consequently, this is classified as a (documentation) bug.

[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 Ogma 1.(0+X).(8+Y).

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 passes the 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/NASA/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=c74eda58e40b4a0b4c53f1504d60cadd3cf64110" -it ogma-test

  • The solution proposed fixes the issues described. Details:
    The issue is with the documentation. There is no good, simple automated way to check that it is correct. Verification performed by visual inspection.

• Implementation is documented. Details:
  The change is to the documentation. No further changes to documentation are needed.
• 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 (change to documentation).

[ivanperez-keera]

Change Manager: Implementation ready to be merged.