Skip to content

Commit 35fb9ed

Browse files
authored
Document that use of auto-set build.board property results in warning (#817)
The previous description made it sound like a convenience feature, with the build.board property only needed if you prefer a custom value for some reason. However, the resulting warning can cause confusion and act as a "red herring" for users of board definitions that don't define a build.board property.
1 parent 34f3b43 commit 35fb9ed

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/platform-specification.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -363,8 +363,8 @@ The **uno.name** property contains the human-friendly name of the board. This is
363363
the "Board Name" field of Arduino CLI's text output, or the "name" key of Arduino CLI's JSON output.
364364

365365
The **uno.build.board** property is used to set a compile-time variable **ARDUINO\_{build.board}** to allow use of
366-
conditional code between `#ifdef`s. A **build.board** value is automatically generated if not defined. In this case the
367-
variable defined at compile time will be `ARDUINO_AVR_UNO`.
366+
conditional code between `#ifdef`s. If not defined, a **build.board** value is automatically generated and the Arduino
367+
development software outputs a warning. In this case the variable defined at compile time will be `ARDUINO_AVR_UNO`.
368368

369369
The other properties will override the corresponding global properties when the user selects the board. These properties
370370
will be globally available, in other configuration files too, without the board ID prefix:

0 commit comments

Comments
 (0)