Merge pull request #263 from peplin/document-flags-vars

Document CFLAGS, CXXFLAGS, ASFLAGS and CPPFLAGS.

1 files changed, 76 insertions, 0 deletions

diff --git a/arduino-mk-vars.md b/arduino-mk-vars.md
index 54608d6..1e8de64 100644
--- a/arduino-mk-vars.md
+++ b/arduino-mk-vars.md
@@ -852,6 +852,82 @@ CXXFLAGS_STD = = -std=gnu++98
 
 ----
 
+### CFLAGS
+
+**Description:**
+
+Flags passed to compiler for files compiled as C. Add more flags to this
+variable using `+=`.
+
+Defaults to all flags required for a typical build.
+
+**Example:**
+
+```Makefile
+CFLAGS += -my-c-only-flag
+```
+
+**Requirement:** *Optional*
+
+----
+
+### CXXFLAGS
+
+**Description:**
+
+Flags passed to the compiler for files compiled as C++. Add more flags to this
+variable using `+=`.
+
+Defaults to all flags required for a typical build.
+
+**Example:**
+
+```Makefile
+CXXFLAGS += -my-c++-onlyflag
+```
+
+**Requirement:** *Optional*
+
+----
+
+### ASFLAGS
+
+**Description:**
+
+Flags passed to compiler for files compiled as assembly (e.g. `.S` files). Add
+more flags to this variable using `+=`.
+
+Defaults to all flags required for a typical build.
+
+**Example:**
+
+```Makefile
+ASFLAGS += -my-as-only-flag
+```
+
+**Requirement:** *Optional*
+
+----
+
+### CPPFLAGS
+
+**Description:**
+
+Flags passed to the C pre-processor (for C, C++ and assembly source flies). Add
+more flags to this variable using `+=`.
+
+Defaults to all flags required for a typical build.
+
+**Example:**
+
+```Makefile
+CPPFLAGS += -DMY_DEFINE_FOR_ALL_SOURCE_TYPES
+```
+
+**Requirement:** *Optional*
+
+----
+
 ### OVERRIDE_EXECUTABLES
 
 **Description:**