aboutsummaryrefslogtreecommitdiff
path: root/arduino-mk-vars.md
diff options
context:
space:
mode:
authorPieter du Preez <pdupreez@gmail.com>2018-03-18 16:54:39 +0100
committerPieter du Preez <pdupreez@gmail.com>2018-03-18 16:54:39 +0100
commit36b6b233eb161f2e086737116710e7667ad237a1 (patch)
treedca8317adc611502c59ce5028374c8dd83f15db2 /arduino-mk-vars.md
parenta7b8084ac6b9b4d94dd91b9b996243432a7de4b3 (diff)
Added the DIAGNOSTICS_COLOR_WHEN var for controlling diagnostics-color.
Some IDEs do not work nicely with the recently added diagnostics-color compiler switch. This patch adds the DIAGNOSTICS_COLOR_WHEN variable, for controlling diagnostics-color switch. The default was chosen to be 'always', which makes the Arduino.mk file backwards compatible with everything up to commit fa82c3a9db (Sat Sep 2 15:32:52 2017 +0100). The supported values for DIAGNOSTICS_COLOR_WHEN are: `always`, `never` and `auto`, and as with all Arduino.mk variables, it can easily be overridden. For more details on the diagnostics-color compiler switch, see: https://gcc.gnu.org/onlinedocs/gcc-4.9.2/gcc/Language-Independent-Options.html#Language-Independent-Options
Diffstat (limited to 'arduino-mk-vars.md')
-rw-r--r--arduino-mk-vars.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/arduino-mk-vars.md b/arduino-mk-vars.md
index e3b6f07..2bc2205 100644
--- a/arduino-mk-vars.md
+++ b/arduino-mk-vars.md
@@ -1047,7 +1047,7 @@ CXXFLAGS_STD = -std=gnu++98
Flags passed to compiler for files compiled as C. Add more flags to this
variable using `+=`.
-Defaults to `undefined` on 1.0 or `-flto -fno-fat-lto-objects -fdiagnostics-color` on AVR toolchain > 4.9.0 (e.g. IDE 1.6.10+)
+Defaults to `undefined` on 1.0 or `-flto -fno-fat-lto-objects -fdiagnostics-color=$(DIAGNOSTICS_COLOR_WHEN)` on AVR toolchain > 4.9.0 (e.g. IDE 1.6.10+)
**Example:**
@@ -1080,6 +1080,30 @@ CXXFLAGS += -my-c++-onlyflag
----
+### DIAGNOSTICS_COLOR_WHEN
+
+**Description:**
+
+This variable controls the compiler's diagnostics-color setting, as defined
+in CFLAGS or CXXFLAGS, on AVR toolchain > 4.9.0.
+Supported values are: `always`, `never` and `auto`.
+For more details, see: [Options to Control Diagnostic Messages Formatting]
+(https://gcc.gnu.org/onlinedocs/gcc-4.9.2/gcc/Language-Independent-Options.html#Language-Independent-Options)
+
+Defaults to `always`.
+
+**Example:**
+
+```Makefile
+DIAGNOSTICS_COLOR_WHEN = never
+# or
+DIAGNOSTICS_COLOR_WHEN = auto
+```
+
+**Requirement:** *Optional*
+
+----
+
### ASFLAGS
**Description:**