Skip to content

Commit 4b29607

Browse files
committed
Increase clarity of command line tool
The command line option --skip-compilation can be confusing, because unit tests must be compiled before they can run. This adds some text to the flag such that the fact that examples are compiled is acknowledged.
1 parent 6eee41a commit 4b29607

File tree

3 files changed

+17
-5
lines changed

3 files changed

+17
-5
lines changed

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
77

88
## [Unreleased]
99
### Added
10+
- `arduino_ci_remote.rb` CLI switch `--skip-examples-compilation`
1011

1112
### Changed
1213
- Move repository from https://github.com/ianfixes/arduino_ci to https://github.com/Arduino-CI/arduino_ci
1314

1415
### Deprecated
16+
- `arduino_ci_remote.rb` CLI switch `--skip-compilation`
1517

1618
### Removed
1719

REFERENCE.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,14 @@ When testing locally, it's often advantageous to limit the number of tests that
1919
This completely skips the unit testing portion of the CI script.
2020

2121

22-
### `--skip-compilation` option
22+
### `--skip-compilation` option (deprecated)
2323

24-
This completely skips the compilation tests (of library examples) portion of the CI script.
24+
This completely skips the compilation tests (of library examples) portion of the CI script. It does not skip the compilation of unit tests.
25+
26+
27+
### `--skip-examples-compilation` option
28+
29+
This completely skips the compilation tests (of library examples) portion of the CI script. It does not skip the compilation of unit tests.
2530

2631

2732
### `--testfile-select` option
@@ -90,8 +95,8 @@ platforms:
9095
9196
### Control How Examples Are Compiled
9297
93-
Put a file `.arduino-ci.yml` in each example directory where you require a different configuration than default.
94-
The `compile:` section controls the platforms on which the compilation will be attempted, as well as any external libraries that must be installed and included.
98+
Put a file `.arduino-ci.yml` in each example directory where you require a different configuration than default.
99+
The `compile:` section controls the platforms on which the compilation will be attempted, as well as any external libraries that must be installed and included.
95100

96101
```yaml
97102
compile:

exe/arduino_ci_remote.rb

+6-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,12 @@ def self.parse(options)
2929
output_options[:skip_unittests] = p
3030
end
3131

32-
opts.on("--skip-compilation", "Don't compile example sketches") do |p|
32+
opts.on("--skip-compilation", "Don't compile example sketches (deprecated)") do |p|
33+
puts "The option --skip-compilation has been deprecated in favor of --skip-examples-compilation"
34+
output_options[:skip_compilation] = p
35+
end
36+
37+
opts.on("--skip-examples-compilation", "Don't compile example sketches") do |p|
3338
output_options[:skip_compilation] = p
3439
end
3540

0 commit comments

Comments
 (0)