Skip to content

Rename fpp-format to fpp-to-fpp - #1062

Draft
Kronos3 wants to merge 2 commits into
mainfrom
remove-fpp-format-pyproject
Draft

Rename fpp-format to fpp-to-fpp#1062
Kronos3 wants to merge 2 commits into
mainfrom
remove-fpp-format-pyproject

Conversation

@Kronos3

@Kronos3 Kronos3 commented Aug 10, 2026

Copy link
Copy Markdown
Collaborator

I am working on integrating the repurposed fprime-fpp-format PIP package with fprime-util format though this alias is conflicting with the other fpp-format executable in the new PIP package.

@bocchino You mentioned updating the user's guide to point to this tool as well, would you like to do that in this PR? I think I'll need an alpha to validate the full pipeline doesn't break before we merge this.

Update August 14, 2026: This PR will now address issue #1073.

@Kronos3 Kronos3 added blocked Issue is blocked pending resolution of another issue fprime-fpp tandem F Prime and FPP tandem development labels Aug 10, 2026
@bocchino bocchino added the alpha release Branch is holding an alpha release that is not merged to main label Aug 12, 2026
@Kronos3 Kronos3 removed the alpha release Branch is holding an alpha release that is not merged to main label Aug 12, 2026
@bocchino

Copy link
Copy Markdown
Collaborator

You mentioned updating the user's guide to point to this tool as well, would you like to do that in this PR?

This needs some more thought. The existing fpp-format tool is used for internal testing of the FPP tools and the F Prime Python model. So we can't just abandon that tool. We should consider renaming it. I'm concerned that if we make fpp-format mean one thing in the user-facing tools and another thing in the developer-facing tools, it will be confusing.

@bocchino

Copy link
Copy Markdown
Collaborator

We should consider renaming it.

@Kronos3 I believe you suggested fpp-to-fpp as an alternate name. I think this is reasonable. I'm also seeing a use case for this in the F Prime Python model testing, where to generate reference output we need to introduce the auto-generated syntax for state machine enums. This tool is also useful for showing what the source files look like after expanding include specifiers. And, if this isn't already done, we can extend it to expanding templates.

@bocchino

Copy link
Copy Markdown
Collaborator

I'd like to keep this PR blocked until we rename the existing fpp-format tool.

@bocchino

Copy link
Copy Markdown
Collaborator

My current thinking is that we should (1) rename fpp-format in this repo and in the exported tools to fpp-to-fpp and (2) update the User's Guide to match. Then formatting FPP won't be handled by this repo at all. It can be handled by the fpp-tools repo. I don't think we need to document fpp-tools in the FPP User's Guide. I think fpp-tools can have its own docs. However, we should point users to fpp-tools and its docs in the README of this repo and in the User's Guide. The README already points to the VS Code plugin. We could also refer to the plugin in the User's Guide. Is there any more we need to do to point users to the tools?

@Kronos3 Kronos3 changed the title Remove fpp-format alias for 'fpp format' Rename fpp-format to fpp-to-fpp Aug 14, 2026
@Kronos3

Kronos3 commented Aug 14, 2026

Copy link
Copy Markdown
Collaborator Author

That sounds good to me, I've renamed the PR and I'll make that update when I get a chance. I think your doc update recommendation sounds good.

@bocchino

Copy link
Copy Markdown
Collaborator

Sounds good, I also opened an issue on this: #1073.

@bocchino
bocchino marked this pull request as draft August 14, 2026 16:02
@bocchino bocchino removed the blocked Issue is blocked pending resolution of another issue label Aug 14, 2026
@bocchino

Copy link
Copy Markdown
Collaborator

Unblocking and converting to draft.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fprime-fpp tandem F Prime and FPP tandem development

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants