Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ogma-cli: Re-order README's TOC to match order of contents. Refs #88. #89

Merged
merged 2 commits into from
May 21, 2023

Conversation

ivanperez-keera
Copy link
Member

Change the order of elements in the table of contents in the README, putting the ROS and FPrime ahead of the C structs, as prescribed in the solution proposed for #88.

@ivanperez-keera
Copy link
Member Author

Change manager: the commit message of the first commit contains a typo in "the order of in the puts those backends first".

The table of contents in the README lists C structs ahead of the ROS and FPrime
backends, but the order of sections in the file puts those backends first.

This commit updates the TOC to reflect the current order.
@ivanperez-keera
Copy link
Member Author

Implementor: Commit message amended.

@ivanperez-keera
Copy link
Member Author

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=48d4fe566854d7a8ca4847a6fa49564a739591ca" -it ogma-test
    • The solution proposed fixes the issues described. Details:
      The issue is with the documentation. Verification is performed by visual inspection.

  • Implementation is documented. Details:
    The change is 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 (change to documentation).

@ivanperez-keera ivanperez-keera merged commit ddb6667 into develop May 21, 2023
@ivanperez-keera ivanperez-keera deleted the develop-readme-toc branch May 21, 2023 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant