From 1dbf07f92609460a24638d544c7fd47ec6e7a9d4 Mon Sep 17 00:00:00 2001
From: chrysn <chrysn@fsfe.org>
Date: Fri, 14 Feb 2020 09:40:03 +0100
Subject: [PATCH] openocd: Add instructions for overriding OPENOCD

---
 dist/tools/openocd/openocd.sh | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/dist/tools/openocd/openocd.sh b/dist/tools/openocd/openocd.sh
index df45b6f6bd..39130b6fbb 100755
--- a/dist/tools/openocd/openocd.sh
+++ b/dist/tools/openocd/openocd.sh
@@ -13,6 +13,11 @@
 #
 # Global environment variables used:
 # OPENOCD:             OpenOCD command name, default: "openocd"
+#                      Care must be taken when specifying an OpenOCD version in
+#                      its build directory, as it does not look up its own
+#                      configuration files relative to the executable -- the
+#                      scripts directory needs to be passed in like this:
+#                      `OPENOCD="~/openocd/src/openocd -s ~/openocd/tcl"`.
 # OPENOCD_CONFIG:      OpenOCD configuration file name,
 #                      default: "${BOARDSDIR}/${BOARD}/dist/openocd.cfg"
 #