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

Suggestion: Safer codal.json for users & create codal.dev.json for development #65

Merged
merged 2 commits into from
Apr 5, 2023

Conversation

microbit-carlos
Copy link
Collaborator

@microbit-carlos microbit-carlos commented Feb 14, 2023

The current codal.json:

  • Has the "dev" option enabled, that clones the main branch from all libraries, which is a bit risky for the average user. The locked target commits should be safer.
  • Enables debug messages, which are good for debugging, but odd for normal users, who might not expect to see additional data being sent to serial and might not know how to turn it off (it's not really documented anywhere)

This settings are useful for CODAL development, so I suggest to keep them in a new separate codal.dev.json (like codal.ble.json), so that devs can simply mv codal.dev.json codal.json after cloning.

This way we leave a safer codal.json configuration for normal users that might just want to create a CODAL C++ micro:bit programme.


This PR also remove the test_ignore key because it's used by build.py only when found in the utils/targets.json file. It probably was accidentally added from copy/pasting the config from utils/targets.json.

Also enables partial flashing on codal.ble.json, which we should probably have on by default.

@JohnVidler
Copy link
Collaborator

Suggest we also document this in the README - can this be added to this PR as well?

@JohnVidler JohnVidler added documentation Improvements or additions to documentation enhancement New feature or request design Issues to do with the architectural or software design labels Mar 9, 2023
Copy link
Collaborator Author

@microbit-carlos microbit-carlos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README updated, this is PR ready for merge, thanks everyone!

@microbit-carlos microbit-carlos force-pushed the no-dev branch 2 times, most recently from 9469555 to 8245fd4 Compare April 5, 2023 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design Issues to do with the architectural or software design documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants