Commit 31cf7a6
authored
Move information re: allowed characters for FQBN component to specifications (#2902)
Arduino CLI restricts which characters can be used by platform developers in their vendor, architecture, board, custom
board menu, and custom board option identifiers.
Previously, the information was only documented(?) in the "FAQ". This type of requirement must be present in the formal
specifications. A platform developer is unlikely to ever think to look for such information in the FAQ.
In addition, the inclusion of such information in the FAQ is not appropriate as this is intended for end users of the
Arduino CLI application and end users have no control over which characters were used by the platform developers in
their identifiers. So the presence of the information in the FAQ only harms readability by introducing unnecessary
complexity into a subject that users often struggle to understand.1 parent 63c44a4 commit 31cf7a6
File tree
3 files changed
+26
-7
lines changed- docs
3 files changed
+26
-7
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
| 14 | + | |
| 15 | + | |
18 | 16 | | |
19 | 17 | | |
20 | 18 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
| 67 | + | |
| 68 | + | |
67 | 69 | | |
68 | 70 | | |
69 | 71 | | |
| |||
260 | 262 | | |
261 | 263 | | |
262 | 264 | | |
| 265 | + | |
| 266 | + | |
263 | 267 | | |
264 | 268 | | |
265 | 269 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| 27 | + | |
| 28 | + | |
27 | 29 | | |
| 30 | + | |
| 31 | + | |
28 | 32 | | |
29 | 33 | | |
30 | 34 | | |
| |||
534 | 538 | | |
535 | 539 | | |
536 | 540 | | |
| 541 | + | |
| 542 | + | |
| 543 | + | |
537 | 544 | | |
538 | 545 | | |
539 | 546 | | |
| |||
1591 | 1598 | | |
1592 | 1599 | | |
1593 | 1600 | | |
1594 | | - | |
1595 | | - | |
| 1601 | + | |
| 1602 | + | |
| 1603 | + | |
| 1604 | + | |
| 1605 | + | |
| 1606 | + | |
| 1607 | + | |
1596 | 1608 | | |
1597 | 1609 | | |
1598 | 1610 | | |
| |||
1627 | 1639 | | |
1628 | 1640 | | |
1629 | 1641 | | |
1630 | | - | |
| 1642 | + | |
| 1643 | + | |
| 1644 | + | |
| 1645 | + | |
| 1646 | + | |
| 1647 | + | |
1631 | 1648 | | |
1632 | 1649 | | |
1633 | 1650 | | |
| |||
0 commit comments