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

AcConstants.ini exists but is not used #1893

Closed
bocchino opened this issue Feb 15, 2023 · 8 comments
Closed

AcConstants.ini exists but is not used #1893

bocchino opened this issue Feb 15, 2023 · 8 comments
Assignees
Labels

Comments

@bocchino
Copy link
Collaborator

Issue

Suggested Solution

  1. Remove AcConstants.ini from the repo.
  2. Update the docs.
@bocchino bocchino added the bug label Feb 15, 2023
@bocchino
Copy link
Collaborator Author

@gjwatney FYI.

@LeStarch
Copy link
Collaborator

@bocchino is this something you would fix? It seems fairly straight-forward.

@bocchino
Copy link
Collaborator Author

bocchino commented Feb 16, 2023

This also needs to be fixed:

https://github.com/nasa/fprime/blob/devel/docs/UsersGuide/user/settings.md

Also, it looks like something in the F Prime tools is using settings.ini to find AcConstants.ini. This should be scrubbed.

@bocchino
Copy link
Collaborator Author

There are also references to AcConstants.ini here and there in the docs, e.g.:

https://github.com/nasa/fprime/blob/devel/Svc/StaticMemory/docs/sdd.md#configuration

We should update these to refer to AcConstants.fpp.

@bocchino
Copy link
Collaborator Author

Also, it looks like something in the F Prime tools is using settings.ini to find AcConstants.ini. This should be scrubbed.

Actually I think this is the first order of business. Otherwise it is not clear what will happen if the AcConstants.ini file is not present, and the tools are expecting it to be there.

@LeStarch
Copy link
Collaborator

LeStarch commented Mar 1, 2023

@bocchino doing this change will break our backward support of the XML modeling language. Have we officially drop that support?

@bocchino
Copy link
Collaborator Author

bocchino commented Mar 1, 2023

doing this change will break our backward support of the XML modeling language

Can you elaborate the use case you have in mind that will break? AcConstants.ini defines some symbols that were used by the old handwritten XML and are not used by the FPP-generated XML. So at a minimum we should delete all those unused symbols and document that AcConstants.ini is there for backwards compatibility. Are you thinking that removing AcConstants.ini entirely will break something that users are doing with their own handwritten XML? That seems unlikely to me, since the purpose of AcConstants.ini was to configure the framework, and we are not using it for that (or for any other) purpose any more.

@bocchino
Copy link
Collaborator Author

bocchino commented Mar 1, 2023

After discussion, hand-writers of XML components might want to use AcConstants.ini to configure their XML. However, we will begin the process of phasing out support for hand-written XML components.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

No branches or pull requests

3 participants