Skip to content

Commit 993bf2d

Browse files
committed
Documentation: Add note about folded Travis CI output
Some popular alternatives to arduino-ci-script simply suppress all compiler output so it's good to make sure users are aware that compilation output is available, but folded.
1 parent 0c4b6f1 commit 993bf2d

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Make some additional checks for compliance with the requirements for adding a li
135135
##### `build_sketch sketchPath boardID allowFail IDEversion`
136136
##### `build_sketch sketchPath boardID allowFail [IDEversionList]`
137137
##### `build_sketch sketchPath boardID allowFail startIDEversion endIDEversion`
138-
Verify/compile sketch(es). `build_sketch` will echo the arduino exit status to the log, which is documented at https://github.com/arduino/Arduino/blob/master/build/shared/manpage.adoc#exit-status.
138+
Verify/compile sketch(es). `build_sketch` will echo the arduino exit status to the log, which is documented at https://github.com/arduino/Arduino/blob/master/build/shared/manpage.adoc#exit-status. Note that in the Travis CI job logs, the compilation output is "folded" to make it easier to browse. You can click the triangles in the left margin to unfold.
139139
- Parameter: **sketchPath** - Path to a sketch or folder containing sketches. If a folder is specified it will be recursively searched and all sketches will be verified.
140140
- Parameter: **boardID** - `package:arch:board[:parameters]` ID of the board to be compiled for. e.g. `arduino:avr:uno`. Board-specific parameters are only supported by Arduino IDE 1.5.5 and newer.
141141
- Parameter: **allowFail** - `true`, `require`, or `false`. Allow the verification to fail without causing the CI build to fail. `require` will cause the build to fail if the sketch verification doesn't fail.

0 commit comments

Comments
 (0)