aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon John <git@the-jedi.co.uk>2014-03-24 00:53:30 +0000
committerSudar <sudar@sudarmuthu.com>2014-03-23 18:30:37 -0700
commit5599d2ab1e23d66640b53e3951f92102f933fbdc (patch)
tree104be4078eccc98f4f549670ab181929a6bd9f13
parentffde764adaa56cf00296857c8fd4a821b6b2e506 (diff)
Add `BOOTLOADER_PARENT` which has to be set if the user sets either of the other two BOOTLOADER variables
Fix #178
-rw-r--r--HISTORY.md1
-rw-r--r--arduino-mk-vars.md26
2 files changed, 24 insertions, 3 deletions
diff --git a/HISTORY.md b/HISTORY.md
index a911d65..92b3d02 100644
--- a/HISTORY.md
+++ b/HISTORY.md
@@ -15,6 +15,7 @@ I tried to give credit whenever possible. If I have missed anyone, kindly add it
- Fix: AVR tools paths for chipKIT in Linux. (https://github.com/peplin)
- Fix: Consider usb or usb:... to be a valid ISP_PORT (https://github.com/geoffholden)
- Add: Add phony target to run pre-build hook script (https://github.com/jrid)
+- Fix: Add BOOTLOADER_PARENT to `arduino-mk-vars.md` and fixed BOOTLOADER_PATH example. (https://github.com/sej7278)
### 1.3.1 (2014-02-04)
- Fix: BUNDLED_AVR_TOOLS_DIR is now set properly when using only arduino-core and not the whole arduino package. (https://github.com/sej7278)
diff --git a/arduino-mk-vars.md b/arduino-mk-vars.md
index 51e32ae..b18aa2b 100644
--- a/arduino-mk-vars.md
+++ b/arduino-mk-vars.md
@@ -1026,7 +1026,7 @@ BOOTLOADER_FILE = optiboot_atmega328.hex
**Description:**
-Path to bootloader file.
+Relative path to bootloader directory.
Usually can be auto-detected as a relative `bootloader.path` from `boards.txt`
@@ -1036,14 +1036,34 @@ Usually can be auto-detected as a relative `bootloader.path` from `boards.txt`
BOOTLOADER_PATH = optiboot
# or
BOOTLOADER_PATH = arduino:atmega
-# or
-BOOTLOADER_PATH = /usr/share/arduino/hardware/arduino/bootloaders/caterina/Caterina-Esplora.hex
```
**Requirement:** *Optional*
----
+### BOOTLOADER_PARENT
+
+**Description:**
+
+Absolute path to bootloader file's parent directory.
+
+Defaults to `/usr/share/arduino/hardware/arduino/bootloaders` (Linux)
+
+**Example:**
+
+```Makefile
+BOOTLOADER_PARENT = ~/sketchbook/hardware/promicro/bootloaders
+BOOTLOADER_PATH = caterina
+BOOTLOADER_FILE = Caterina-promicro16.hex
+```
+
+Would result in an absolute path to the bootloader hex file of `~/sketchbook/hardware/promicro/bootloaders/caterina/Caterina-promicro16.hex`
+
+**Requirement:** *Optional, unless BOOTLOADER_FILE and/or BOOTLOADER_PATH are user-defined*
+
+----
+
## ChipKIT variables
### MPIDE_DIR