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

Clean up preferences handling and make them more consistent #4431

Open
matthijskooijman opened this issue Jan 15, 2016 · 1 comment
Open
Labels
arduino-builder The tool used to handle the Arduino sketch compilation process arduino-cli Related to the arduino-cli tool Component: Documentation Related to Arduino's documentation content feature request A request to make an enhancement (not a bug fix)

Comments

@matthijskooijman
Copy link
Collaborator

Currently, there are a lot of places where configuration values can come from. There is preferences.txt, boards.txt, platform.txt, programmers.txt and some runtime generated values. Each of these somehow contribute to the values used for building, uploading, showing the interface, etc., but I believe this process is not entirely clear. Some values can be set in one place, some can be overridden in other places (but not all), etc.

It would be good to:

  • Have better documentation about the available options
  • Make the way options are used more consistent
  • Try to keep backward compatibility as much as possible (perhaps by adding an explicit version number to all these files?)

As part of this, overriding options should probably be more explicit, and less accidental or ad-hoc as it is now. Explicitely specifying overrides (using e.g. an override. prefix) could help here, and/or making the source of a preference (or perhaps more the intended use of it) using prefixes like board., build., platform., pref. etc. I'm not sure how this should work exactly yet, but some thought should go into this in any case.

@lmihalkovic voiced similar ideas here: #4102 (comment)

Another related issue that should probably be fixed as part of this, is allowing custom compiler flags, as discussed in #421.

@lmihalkovic
Copy link

I would offer that looking at this in the context of #4421 will give you some useful extra requirements. this is not to say that #4421 has to be done, but simply that looking at this with the thinking 'lets make sure that its implementation does not make doing something the like of #4421 a bigger effort' then some of what looks now like possible design will be eliminated.

@per1234 per1234 added arduino-builder The tool used to handle the Arduino sketch compilation process arduino-cli Related to the arduino-cli tool Component: Documentation Related to Arduino's documentation content feature request A request to make an enhancement (not a bug fix) labels Aug 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arduino-builder The tool used to handle the Arduino sketch compilation process arduino-cli Related to the arduino-cli tool Component: Documentation Related to Arduino's documentation content feature request A request to make an enhancement (not a bug fix)
Projects
None yet
Development

No branches or pull requests

3 participants