From 908653d0db682c9ba71f3126b7b00645a22906d5 Mon Sep 17 00:00:00 2001 From: per1234 Date: Sat, 4 Jul 2020 15:43:10 -0700 Subject: [PATCH] [skip ci] Document location priority of custom libraries paths Custom libraries paths may be specified via arduino-cli compile --libraries. --- docs/sketch-build-process.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sketch-build-process.md b/docs/sketch-build-process.md index 8f8cf09fe03..739150f04d1 100644 --- a/docs/sketch-build-process.md +++ b/docs/sketch-build-process.md @@ -73,6 +73,7 @@ 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 a custom libraries path specified via the [`--libraries` option](../commands/arduino-cli_compile/#options) of `arduino-cli compile` (in decreasing order of priority when multiple custom paths are defined) 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