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

Add support for global build defines and options #8504

Merged
merged 30 commits into from
May 12, 2022

Conversation

mhightower83
Copy link
Contributor

@mhightower83 mhightower83 commented Mar 6, 2022

A script that manages the use of a file with a unique name, like Sketch.ino.globals.h, in the sketch source directory, to provide compiler command-line options (build options) and sketch global #define macros. The build option data is encapsulated in a unique "C" comment block and extracted into the build tree during prebuild.

A script manages the use of a file with a unique name, like
`SketchName.ino.globals.h`, in the Sketch source directory to provide compiler
command-line options (build options) and sketch global defines. The build
option data is encapsulated in a unique "C" comment block and extracted into
the build tree during prebuild.
…s file path issue.

Improved helpful message for adding embedded build options.
added workaround for aggressive caching
Added portable path for preferences.txt
Expanded file timestamp granularity
Improved error message printing for Arduino IDE 2.0 RC4
@mhightower83 mhightower83 marked this pull request as ready for review March 12, 2022 22:27
d-a-v and others added 9 commits March 13, 2022 23:39
When global header file does not exist, this print makes it easier for user to create the header file by providing its name and documentation pointer.
Compiler command line changes from build.opt are shown to user
Grouped helpful info to print at the end.
Added missing return value.
More improvements to printing
Updated docs.
Support hints for compiler.cache_core. For use when Arduino IDE uses
command-line options that override compiler.cache_core.

Removed overuse of ()

Improve FAQ entry
Rely on argpaser for checking that all arguments are present.
Removed redundant argument check in main().

Added '--debug' option and print_dbg method.

Rethink failures on overrides. Remove well know path fallbacks,
error exit when override file is missing.

In well-known path search for preferences.txt, do not assume true.
Make failure to find an error exit event.

When Windows has two preferences.txt files and they have different
values for caching and globals.h is used, error exit. It is not
possible to know from the script which is being used.
Copy link
Collaborator

@d-a-v d-a-v left a comment

Choose a reason for hiding this comment

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

Thanks a lot for this proposal.
It is an excellent replacement to a feature-request which is still not available upstream.

@d-a-v d-a-v added the alpha included in alpha release label Mar 27, 2022
@d-a-v d-a-v added this to the 3.1 milestone Mar 27, 2022
@d-a-v d-a-v mentioned this pull request Mar 28, 2022
6 tasks
Update comment
Include the @ within the expantion string use quotes around file name.
Update doc example to remind and use quotes.
Added "mkbuildoptglobals.extra_flags=--cache_core" to platform.loca.txt
Update "-ide-version=10802" this version number indicates aggressive caching support
Added example to test global .h support
Added --debug to CI - this needs to be removed later
Tweaks to touch...
temp CI changes
debug crud
Added --ci switch
mhightower83 and others added 6 commits March 31, 2022 14:06
run_CI_locall.sh works fine locally. Hosted Multi-VM CI fails
to work with 'aggressive caching' workaround method.

Add #if defined(CORE_MOCK) to failing example.
mkbuildoptglobals.py is optimized around the Arduino IDE 1.x
behaviour. One way the CI differs from the Arduino IDE is in the
handling of core and caching core. With the Arduino IDE, each sketch
has a private copy of core and contributes to a core cache. With the
CI, there is one shared copy of core for all sketches. When global
options are used, the shared copy of core and cache are removed before
and after the build.
@klew
Copy link

klew commented Jan 13, 2023

Is similar feature available in ESP32 boards? If not, is it planned to be ported?

@d-a-v
Copy link
Collaborator

d-a-v commented Jan 13, 2023

Please ask them directly (arduino/esp32).

Best is to ask Arduino themselves. There are lots en entry-points about this subject.
I will not flood, so I'll give only one: arduino/arduino-cli#846 . Please note the "criticality: high" tag they added recently.

...

Well, I will add this one because they still have not closed it yet despite the fact that they should have after months of inactivity.

PS: @mhightower83 Thanks for this addition

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
alpha included in alpha release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants