Skip to content

Commit

Permalink
Display useful message when Linux post-install script has insufficien…
Browse files Browse the repository at this point in the history
…t permissions

The Arduino Boards Manager automatically executes the `post_install.sh` script during installation of the platform on a
Linux machine.

This platform's post-install script is intended to create a udev rules file that gives write permissions for the USB
devices of the platform's boards. These permissions are required in order to upload to the boards.

The creation of the udev rules file requires superuser privileges, which are typically not available in the context of
the post-install script's execution. The script contains code to check whether the necessary privileges are available.
If not, it prints a message and skips the udev rules file creation.

Previously the message printed when the udev rules file creation was not possible was "Please run as root". This message
was completely meaningless to the user when printed during the Boards Manager installation. Worse, it might cause them
to think they must run the Arduino development software as root user, which is a bad idea and also wouldn't result in
the udev rules file being created since the installation of the platform to the user's account was already completed.

The message is hereby updated to provide a meaningful explanation of the potential problem as well as the specific
command the user can run from the terminal to execute the script as superuser.
  • Loading branch information
per1234 authored Jun 10, 2024
1 parent 6293cea commit daea2f1
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions post_install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,19 @@ SUBSYSTEMS=="usb", ATTRS{idVendor}=="0525", MODE:="0666"
EOF
}

if [ "$EUID" -ne 0 ]
then echo "Please run as root"
if [ "$EUID" -ne 0 ]; then
if [ -e "${PWD}/post_install.sh" ]; then
echo
echo "You might need to configure permissions for uploading."
echo "To do so, run the following command from the terminal:"
echo "sudo \"${PWD}/post_install.sh\""
echo
else
# Script was executed from another path. It is assumed this will only occur when user is executing script directly.
# So it is not necessary to provide the command line.
echo "Please run as root"
fi

exit
fi

Expand Down

0 comments on commit daea2f1

Please sign in to comment.