Nothing Special   »   [go: up one dir, main page]

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: Table of contents in README does not match order of contents #88

Closed
ivanperez-keera opened this issue May 21, 2023 · 6 comments
Assignees
Labels
CR:Status:Closed Admin only: Change request that has been completed CR:Type:Bug Admin only: Change request pertaining to error detected
Milestone

Comments

@ivanperez-keera
Copy link
Member
ivanperez-keera commented May 21, 2023

Description

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. The TOC should be updated to reflect the current order.

Type

  • Bug: order 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's TOC lists the main Copilot, cFS, ROS and FPrime backends first, and then lists the C structs parsing features.

Desired result

The README's TOC lists the main Copilot, cFS, ROS and FPrime backends first, and then lists the C structs parsing features.

Proposed solution

Change the order of elements in the table of contents in the README, to put ROS and FPrime ahead of C structs everywhere.

Further notes

None.

@ivanperez-keera ivanperez-keera added CR:Status:Initiated Admin only: Change request that has been initiated CR:Type:Bug Admin only: Change request pertaining to error detected labels May 21, 2023
@ivanperez-keera
Copy link
Member Author

Change Manager: Confirmed that the issue exists.

@ivanperez-keera ivanperez-keera added CR:Status:Confirmed Admin only: Change request that has been acknowledged by the change manager and removed CR:Status:Initiated Admin only: Change request that has been initiated labels May 21, 2023
@ivanperez-keera
Copy link
Member Author

Technical Lead: Confirmed that the issue should be addressed.

@ivanperez-keera ivanperez-keera added CR:Status:Accepted Admin only: Change request accepted by technical lead and removed CR:Status:Confirmed Admin only: Change request that has been acknowledged by the change manager labels May 21, 2023
@ivanperez-keera
Copy link
Member Author

Technical Lead: Issue scheduled for Ogma 1.(0+X).(8+Y).

Fix assigned to: @ivanperez-keera.

@ivanperez-keera ivanperez-keera added CR:Status:Scheduled Admin only: Change requested scheduled and removed CR:Status:Accepted Admin only: Change request accepted by technical lead labels May 21, 2023
@ivanperez-keera ivanperez-keera self-assigned this May 21, 2023
@ivanperez-keera ivanperez-keera added this to the Release 1.(0+X).(8+Y) milestone May 21, 2023
@ivanperez-keera ivanperez-keera added CR:Status:Implementation Admin only: Change request that is currently being implemented and removed CR:Status:Scheduled Admin only: Change requested scheduled labels May 21, 2023
ivanperez-keera added a commit that referenced this issue May 21, 2023
The table of contents in the README lists C structs ahead of the ROS and FPrime
backends, but the order of in the puts those backends first.

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

Implementor: Solution implemented, review requested.

@ivanperez-keera ivanperez-keera added CR:Status:Verification Admin only: Change request that is currently being verified and removed CR:Status:Implementation Admin only: Change request that is currently being implemented labels May 21, 2023
ivanperez-keera added a commit that referenced this issue May 21, 2023
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

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
Copy link
Member Author

Change Manager: Implementation ready to be merged.

@ivanperez-keera ivanperez-keera added CR:Status:Closed Admin only: Change request that has been completed and removed CR:Status:Verification Admin only: Change request that is currently being verified labels May 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CR:Status:Closed Admin only: Change request that has been completed CR:Type:Bug Admin only: Change request pertaining to error detected
Projects
None yet
Development

No branches or pull requests

1 participant