From e00ea42932af1c5fbe027fa4d35248180c8a09f2 Mon Sep 17 00:00:00 2001 From: per1234 Date: Sat, 30 May 2020 21:30:12 -0700 Subject: [PATCH] [skip changelog] Make library location priority documentation more relevant to Arduino CLI This section of the documentation was written with a focus on the Arduino IDE, and thus was not very friendly to Arduino CLI users. --- docs/sketch-build-process.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sketch-build-process.md b/docs/sketch-build-process.md index 908fa84b78f..8f8cf09fe03 100644 --- a/docs/sketch-build-process.md +++ b/docs/sketch-build-process.md @@ -73,10 +73,11 @@ The folder name contains the include | `AnAwesomeServoForWhatever` The "location priority" is determined as follows (in order of highest to lowest priority): -1. The library is in the sketchbook (`{sketchbook path}/libraries`) +1. The library is in the `libraries` subfolder of the IDE's sketchbook or Arduino CLI's user directory 1. The library is bundled with the board platform/core ([`{runtime.platform.path}/libraries`](platform-specification.md#global-predefined-properties)) 1. The library is bundled with the [referenced](platform-specification.md#referencing-another-core-variant-or-tool) board platform/core 1. The library is bundled with the Arduino IDE ([`{runtime.ide.path}/libraries`](platform-specification.md#global-predefined-properties)) + - This location is only used by Arduino CLI when it's located in the Arduino IDE installation folder ## Compilation