Skip to content

Commit 0bf48ae

Browse files
authored
[skip changelog] Document platform post-install script in platform specification (#942)
This feature has recently become available for the use by 3rd party platform developers, so documenting it becomes even more important.
1 parent 7f9f135 commit 0bf48ae

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

Diff for: docs/platform-specification.md

+20
Original file line numberDiff line numberDiff line change
@@ -984,3 +984,23 @@ For more information, see the [Arduino library specification](library-specificat
984984
As of Arduino IDE 1.6.6, per-platform keywords can be defined by adding a keywords.txt file to the platform's
985985
architecture folder. These keywords are only highlighted in the Arduino IDE when one of the boards of that platform are
986986
selected. This file follows the [same format](library-specification.md#keywords) as the keywords.txt used in libraries.
987+
988+
## Post-install script
989+
990+
After Boards Manager finishes installation of a platform, it checks for the presence of a script named:
991+
992+
- `post_install.bat` - when running on Windows
993+
- `post_install.sh` - when running on any non-Windows operating system
994+
995+
If present, the script is executed.
996+
997+
This script may be used to configure the user's system for the platform, such as installing drivers.
998+
999+
The circumstances under which the post-install script will run are different depending on which Arduino development
1000+
software is in use:
1001+
1002+
- **Arduino IDE**: (all versions) runs the script when the installed platform is signed with Arduino's private key.
1003+
- **Arduino CLI**: (since 0.12.0) runs the script for any installed platform when Arduino CLI is in "interactive" mode.
1004+
This behavior
1005+
[can be configured](https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_core_install/#options)
1006+
- **Arduino Pro IDE**: (since 0.1.0) runs the script for any installed platform.

0 commit comments

Comments
 (0)