Skip to content

Confusion over skip-compilation option #175

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
jgfoster opened this issue Oct 6, 2020 · 1 comment · Fixed by #183
Closed

Confusion over skip-compilation option #175

jgfoster opened this issue Oct 6, 2020 · 1 comment · Fixed by #183
Labels
ci scripts The test runner scripts enhancement New feature or request

Comments

@jgfoster
Copy link
Member

jgfoster commented Oct 6, 2020

As described in REFERENCE.md, this framework will (compile and) run all the code in the test directory on the developer's desktop/laptop against the mock Arduino board. Then, as a separate task an attempt is made to build everything in the examples directory using the Arduino IDE (which has different includes and a different compiler) so as to avoid later surprises due to the different build environment and target. These tasks are very reasonable and distinct, but I was confused by the names.

I spent a lot of time fiddling with test code to get the unit tests to compile and run and the idea that I'm running the unit tests without compiling seems very odd. Now that I'm understanding better I wonder if "compilation of examples" would be a better phrase (even though it is more verbose).

So, the command line option --skip-compilation would probably remain but would be deprecated in favor of --skip-compilation-of-examples or simply --skip-examples (more analogous to --skip-unittests).

@ianfixes ianfixes added ci scripts The test runner scripts enhancement New feature or request labels Oct 16, 2020
@ianfixes
Copy link
Collaborator

I'll probably do --skip-examples-compilation, this is a great suggestion

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci scripts The test runner scripts enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants