Skip to content

Commit fffbeaa

Browse files
authored
[skip changelog] Update all mentions of Arduino Pro IDE (arduino#1966)
The Arduino Pro IDE application was mentioned several places throughout the documentation. That project became Arduino IDE 2.x 1.5 years ago while still in the alpha development phase. All users of the project will now know it by the name "Arduino IDE 2.x", so the documentation should do the same.
1 parent e6e5dd6 commit fffbeaa

4 files changed

+23
-25
lines changed

Diff for: docs/integration-options.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
The Arduino CLI is an open source Command Line Application written in [Golang] that can be used from a terminal to
44
compile, verify and upload sketches to Arduino boards and that’s capable of managing all the software and tools needed
55
in the process. But don’t get fooled by its name: Arduino CLI can do much more than the average console application, as
6-
shown by the [Arduino Pro IDE] and [Arduino Cloud], which rely on it for similar purposes but each one in a completely
7-
different way from the other. In this article we introduce the three pillars of the Arduino CLI, explaining how we
8-
designed the software so that it can be effectively leveraged under different scenarios.
6+
shown by [Arduino IDE 2.x][arduino ide 2.x] and [Arduino Cloud], which rely on it for similar purposes but each one in a
7+
completely different way from the other. In this article we introduce the three pillars of the Arduino CLI, explaining
8+
how we designed the software so that it can be effectively leveraged under different scenarios.
99

1010
## The first pillar: command line interface
1111

@@ -57,10 +57,10 @@ instance:
5757

5858
gRPC is language agnostic: even if the example is written in Golang, the programming language used for the client can be
5959
Python, JavaScript or any of the many [supported ones][grpc supported languages], leading to a variety of possible
60-
scenarios. The new [Arduino Pro IDE] is a good example of how to leverage the daemon mode of the Arduino CLI with a
61-
clean separation of concerns: the Pro IDE knows nothing about how to download a core, compile a sketch or talk to an
60+
scenarios. [Arduino IDE 2.x][arduino ide 2.x] is a good example of how to leverage the daemon mode of the Arduino CLI
61+
with a clean separation of concerns: the IDE knows nothing about how to download a core, compile a sketch or talk to an
6262
Arduino board and it demands all these features of an Arduino CLI instance. Conversely, the Arduino CLI doesn’t even
63-
know that the client that’s connected is the Pro IDE, and neither does it care.
63+
know that the client that’s connected is the Arduino IDE, and neither does it care.
6464

6565
For more information on Arduino CLI's gRPC interface, see the [gRPC interface reference].
6666

@@ -88,7 +88,7 @@ designed the low level API, have a look at the [commands package] and don’t he
8888
tracker] if you’ve got a use case that doesn’t fit one of the three pillars.
8989

9090
[golang]: https://go.dev/
91-
[arduino pro ide]: https://www.arduino.cc/pro/arduino-pro-ide
91+
[arduino ide 2.x]: https://github.com/arduino/arduino-ide
9292
[arduino cloud]: https://cloud.arduino.cc/home
9393
[continuous integration]: https://en.wikipedia.org/wiki/Continuous_integration
9494
[continuous deployment]: https://en.wikipedia.org/wiki/Continuous_deployment

Diff for: docs/library-specification.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ allowing the compilation to fail in a difficult to understand way):
418418

419419
## Old library format (pre-1.5)
420420

421-
In order to support old libraries (from Arduino IDE 1.0.x), the Arduino IDE/Pro IDE and Arduino CLI will also compile
422-
libraries missing a library.properties metadata file. As a result, these libraries should behave as they did in Arduino
423-
IDE 1.0.x, although they will be available for all boards, including non-AVR ones (which wouldn’t have been present in
424-
Arduino IDE 1.0.x).
421+
In order to support old libraries (from Arduino IDE 1.0.x), Arduino IDE and Arduino CLI will also compile libraries
422+
missing a library.properties metadata file. As a result, these libraries should behave as they did in Arduino IDE 1.0.x,
423+
although they will be available for all boards, including non-AVR ones (which wouldn’t have been present in Arduino IDE
424+
1.0.x).

Diff for: docs/package_index_json-specification.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ Introduced in Arduino IDE 1.6.4, Boards Manager makes it easy to install and upd
22
provide Boards Manager installation support for a platform, a JSON formatted index file must be published. This is the
33
specification for that file.
44

5-
Boards Manager functionality is provided by [Arduino CLI](getting-started.md#adding-3rd-party-cores),
6-
[Arduino IDE](https://docs.arduino.cc/learn/starting-guide/cores), and Arduino Pro IDE.
5+
Boards Manager functionality is provided by [Arduino CLI](getting-started.md#adding-3rd-party-cores) and
6+
[Arduino IDE](https://docs.arduino.cc/learn/starting-guide/cores).
77

88
## Naming of the JSON index file
99

@@ -64,9 +64,8 @@ The metadata fields are:
6464
- `name`: the folder used for the installed cores. The
6565
[vendor folder](platform-specification.md#hardware-folders-structure) name of the installed package is determined by
6666
this field
67-
- `maintainer`: the extended name of the vendor that is displayed on the Arduino IDE/Pro IDE's Boards Manager GUI
68-
- `websiteURL`: the URL to the vendor's website, appears on the Arduino IDE/Pro IDE's Boards Manager as a "More info"
69-
link
67+
- `maintainer`: the extended name of the vendor that is displayed on the Arduino IDE Boards Manager GUI
68+
- `websiteURL`: the URL to the vendor's website, appears on the Arduino IDE Boards Manager as a "More info" link
7069
- `email`: the email of the vendor/maintainer
7170

7271
Now, before looking at `PLATFORMS`, let's explore first how `TOOLS` are made.
@@ -241,8 +240,8 @@ Each PLATFORM describes a core for a specific architecture. The fields needed ar
241240
- `help`/`online`: is a URL that is displayed on the Arduino IDE's Boards Manager as an "Online Help" link
242241
- `url`, `archiveFileName`, `size` and `checksum`: metadata of the core archive file. The meaning is the same as for the
243242
TOOLS
244-
- `boards`: the list of boards supported (note: just the names to display on the Arduino IDE and Arduino Pro IDE's
245-
Boards Manager GUI! the real boards definitions are inside `boards.txt` inside the core archive file)
243+
- `boards`: the list of boards supported (note: just the names to display on the Arduino IDE's Boards Manager GUI! the
244+
real boards definitions are inside `boards.txt` inside the core archive file)
246245
- `toolsDependencies`: the tools needed by this platform. They will be installed by Boards Manager along with the
247246
platform. Each tool is referenced by the triple (`packager`, `name`, `version`) as previously said. Note that you can
248247
reference tools available in other packages as well, even if no platform of that package is installed.

Diff for: docs/platform-specification.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -1330,10 +1330,9 @@ platform's platform.txt is done as usual.
13301330

13311331
### Sketch debugging configuration
13321332

1333-
Starting from Arduino CLI 0.9.0 / Arduino Pro IDE v0.0.5-alpha.preview, sketch debugging support is available for
1334-
platforms.
1333+
Starting from Arduino CLI 0.9.0 / Arduino IDE 2.x, sketch debugging support is available for platforms.
13351334

1336-
The debug action is triggered when the user clicks the Debug button in the Arduino Pro IDE or runs the
1335+
The debug action is triggered when the user clicks the Debug button in the Arduino IDE or runs the
13371336
[`arduino-cli debug`](commands/arduino-cli_debug.md) command.
13381337

13391338
The compiler optimization level that is appropriate for normal usage will often not provide a good experience while
@@ -1486,8 +1485,8 @@ myboard.bootloader.tool=arduino:avrdude
14861485
[....]
14871486
```
14881487

1489-
When using Arduino CLI or Arduino Pro IDE (but not Arduino IDE), properties used in the referenced tool recipe may be
1490-
overridden in the referencing platform's platform.txt.
1488+
When using Arduino CLI or Arduino IDE 2.x (but not Arduino IDE 1.x), properties used in the referenced tool recipe may
1489+
be overridden in the referencing platform's platform.txt.
14911490

14921491
Note that, unlike core references, referencing a tool recipe does _not_ result in any other resources being inherited
14931492
from the referenced platform.
@@ -1548,8 +1547,8 @@ This script may be used to configure the user's system for the platform, such as
15481547
The circumstances under which the post-install script will run are different depending on which Arduino development
15491548
software is in use:
15501549

1551-
- **Arduino IDE**: (all versions) runs the script when the installed platform is signed with Arduino's private key.
1550+
- **Arduino IDE 1.x**: runs the script when the installed platform is signed with Arduino's private key.
1551+
- **Arduino IDE 2.x**: runs the script for any installed platform.
15521552
- **Arduino CLI**: (since 0.12.0) runs the script for any installed platform when Arduino CLI is in "interactive" mode.
15531553
This behavior
15541554
[can be configured](https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_core_install/#options)
1555-
- **Arduino Pro IDE**: (since 0.1.0) runs the script for any installed platform.

0 commit comments

Comments
 (0)