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: Present conversion options based on backends #75

Closed
ivanperez-keera opened this issue Jan 28, 2023 · 6 comments
Closed

ogma-cli: Present conversion options based on backends #75

ivanperez-keera opened this issue Jan 28, 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 Jan 28, 2023

Description

The sections of the README list conversion of FRET files first, then the cFS command, then the C structs conversion, then the ROS command.

This presentation is partly misleading, since FRET commands can also be fed to some backends.

A better way to present the information would be to list the backends available (conversion to Copilot/stand-alone C, conversion to cFS, conversion to ROS, conversion to FPrime), giving examples of the input formats.

Type

  • Bug: presentation 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 file is structured around the backends and features, rather than the inputs.

Desired result

The README file is structured around the backends and features, rather than the inputs.

Proposed solution

Lay out elements in README as follows:

  • Describe purpose and intro.
  • Describe backends, using the frontends supported as examples.

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 Jan 28, 2023
@ivanperez-keera ivanperez-keera changed the title ogma-cli: Present conversion options based on the frontends and backends without mixing them ogma-cli: Present conversion options based on frontends and backends without mixing them Jan 28, 2023
@ivanperez-keera ivanperez-keera changed the title ogma-cli: Present conversion options based on frontends and backends without mixing them ogma-cli: Present conversion options based on backends Jan 18, 2024
@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 Jan 18, 2024
@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 Jan 18, 2024
@ivanperez-keera
Copy link
Member Author

Technical Lead: Issue scheduled for fixing in Ogma 1.2.

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 Jan 18, 2024
@ivanperez-keera ivanperez-keera self-assigned this Jan 18, 2024
@ivanperez-keera ivanperez-keera added this to the 1.2.0 milestone Jan 18, 2024
ivanperez-keera added a commit that referenced this issue Jan 18, 2024
The README is too focused on the frontends, but most users will mostly
care about the backends.

This commit re-structures the README around the targets or backends,
which are the ones what most users will care the most about.
@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 Jan 18, 2024
@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 Jan 18, 2024
@ivanperez-keera
Copy link
Member Author

Change Manager: Verified that:

  • Solution is implemented:
    • The code proposed compiles and passes all 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/ivanperez-keera/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=41ef5b5f31fe4be8de06b4b2c8935eb10e0f1c01" -it ogma-test
    • The solution proposed fixes the issues described.
      The change is to the README, so the solution is checked by visual inspection. The README is not focused on the targets and functionalities provided by Ogma.
  • Implementation is documented. Details:
    The update is to 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; bump executed.

@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 Jan 18, 2024
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