Skip to content

Sloeber 4.4 removing a configuration via version control does not work #1350

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

Closed
jantje opened this issue Jun 4, 2021 · 2 comments
Closed
Labels
domain: version control importance: usability OS: all status: known limitation This is soimething we can live with status: no good solution found (yet) We don't know how to fix this. status: workaround documented A workaround has been confirmed to solve this issue.

Comments

@jantje
Copy link
Member

jantje commented Jun 4, 2021

Make a project with 2 configurations that both have the "share in version control"
Your project now contains a sloeber.cfg showing the settings of both configs.
Delete all the lines of 1 config and save the sloeber.cfg file
--This is what would happen if the configuration was removed from version control by someone else--
expected behaviour
The config is no longer shared in version control
Actual behaviour
The config is removed from sloeber.cfg but the "share in version control" flag is still set so the next time you do project properties->arduino->apply close it will reappear

Work around
How to know this happened: Git staging will tell you that sloeber.cfg has changed and tell you a config was added; this should tell you that you shared the config that was removed by another team member

Action to fix:
Manually remove the "share in version control" flag from the project properties->arduino->other tab
Now the version contol tool should state there are no changes to sloeber.cfg

@jantje
Copy link
Member Author

jantje commented Jun 4, 2021

The root cause of this issue is
Sloeber reads the .sproject file and then the sloeber.cfg file.
This makes the sloeber.cfg to overwrite the settings in the .sproject file
However in this case the settings are removed in sloeber.cfg and the values in .sproject are used
There the config still exists (which is the desired behaviour) with the "share in version control" flag on (which is not desired behaviour)

As this is a rare use case with an easy work around which will probably not be so easy to fix in the code I do not intend to fix this as part of the 4.4 release

@jantje jantje added status: known limitation This is soimething we can live with status: no good solution found (yet) We don't know how to fix this. labels Jun 27, 2021
@jantje jantje removed the status: known limitation This is soimething we can live with label Jul 23, 2021
@jantje jantje added the status: known limitation This is soimething we can live with label Aug 27, 2021
@jantje
Copy link
Member Author

jantje commented Aug 27, 2021

I'm closing this as a know limitation; won't fix unless there is huge request as workaround is easy and frequency of the case is limited

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain: version control importance: usability OS: all status: known limitation This is soimething we can live with status: no good solution found (yet) We don't know how to fix this. status: workaround documented A workaround has been confirmed to solve this issue.
Projects
None yet
Development

No branches or pull requests

1 participant