ogma-core: Documentation refers to wrong system

[ivanperez-keera]

Description

The documentation of ogma-core/src/Language/Trans/SMV2Copilot.hs does not refer to the boolean expressions as those in the SMV language, but incorrectly refers to them as FRET expressions, which was old documentation left over after renaming the module.

Type

• Bug: incorrect documentation.

Additional context

None.

Requester

• Ivan Perez.

Method to check presence of bug

The output of the following command should be empty:

$ grep -nHire 'fret' ogma-core/src/Language/Trans/SMV2Copilot.hs

It instead lists a number of occurrences.

Expected result

The module should refer to the expressions as SMV boolean expressions.

Desired result

The module should refer to the expressions as SMV boolean expressions.

Proposed solution

Rename all instances of FRET to SMV in ogma-core/src/Language/Trans/SMV2Copilot.hs.

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

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:
    • Build logs:
      • https://github.com/nasa/ogma/actions/runs/11980702463/job/33405497166
      • https://github.com/nasa/ogma/actions/runs/11980702552/job/33405497432
    • Build log archives:
      • logs_31235252235.zip
      • logs_31235252486.zip
  • The solution proposed produces the expected result. Details:
    The following dockerfile checks that the module does not contain any outdated references, after which it prints the message "Success":

    FROM ubuntu:focal
    
    RUN apt-get update
    
    RUN apt-get install --yes git
    
    SHELL ["/bin/bash", "-c"]
    CMD git clone $REPO \
        && cd $NAME \
        && git checkout $COMMIT \
        && ! grep -niHre 'fret' ogma-core/src/Language/Trans/SMV2Copilot.hs \
        && echo "Success"

    Command (substitute variables based on new path after merge):

    $ docker run -e "REPO=https://github.com/ivanperez-keera/ogma" -e "NAME=ogma" -e "PAT=ogma"  -e "COMMIT=5092faf6fbf346b9d5ad59aa0c9c7553f76c1410" -it ogma-verify-176
    

• Implementation is documented. Details:
  Change is to the documentation.
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  No updates needed; change is in module documentation.
• Required version bumps are evaluated. Details:
  No bumps needed; change is in module documentation.

[ivanperez-keera]

Change Manager: Implementation ready to be merged.