-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop-doc-smv' into develop. Close #176.
**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: ```sh $ grep -nHire 'fret' ogma-core/src/Language/Trans/SMV2Copilot.hs ``` It instead lists a number of occurrences. The following dockerfile checks that the module does not contain any outdated references, after which it prints the message "Success": ```Dockerfile 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): ```sh $ docker run -e "REPO=https://github.com/NASA/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=<HASH>" -it ogma-verify-176 ``` **Expected result** The module should refer to the expressions as SMV boolean expressions. Running the dockerfile above prints the message "Success", indicating that all outdated references have been updated. **Solution implemented** Rename all instances of FRET to SMV in `ogma-core/src/Language/Trans/SMV2Copilot.hs`. **Further notes** None.
- Loading branch information
Showing
2 changed files
with
15 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters