aboutsummaryrefslogtreecommitdiff
path: root/arduino-mk-vars.md
diff options
context:
space:
mode:
authorSudar Muthu <sudar@sudarmuthu.com>2017-09-04 22:21:56 -0400
committerGitHub <noreply@github.com>2017-09-04 22:21:56 -0400
commit360db6f27c03781554171daae734aabde05ee3b7 (patch)
tree12ce3ae76cee36bf5f9130bad5de89508d4f0dfd /arduino-mk-vars.md
parent983db51764265435b007b69cea6d8a25075c83c0 (diff)
parent73426bc2339116641e9227d5d7af1a70e3dd23fa (diff)
Merge pull request #502 from tuna-f1sh/master
Support for generation of project tags file
Diffstat (limited to 'arduino-mk-vars.md')
-rw-r--r--arduino-mk-vars.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/arduino-mk-vars.md b/arduino-mk-vars.md
index 0f93c89..d19d3d6 100644
--- a/arduino-mk-vars.md
+++ b/arduino-mk-vars.md
@@ -11,6 +11,7 @@ The following are the different variables that can be overwritten in the user ma
* [Avrdude setting variables](#avrdude-setting-variables)
* [Bootloader variables](#bootloader-variables)
* [ChipKIT variables](#chipkit-variables)
+* [Ctags variables](#ctags-variables)
## Global variables
@@ -1404,6 +1405,57 @@ MPIDE_DIR = $(HOME)/mpide
----
+## Ctags variables
+
+### TAGS_FILE
+
+**Description:**
+
+Output file name for tags. Defaults to 'tags'.
+
+**Example:**
+
+```Makefile
+TAGS_FILE = .tags
+```
+
+**Requirement:** *Optional*
+
+----
+
+### CTAGS_OPTS
+
+**Description:**
+
+Additional options to pass to `ctags` command.
+
+**Example:**
+
+```Makefile
+# Run ctags in verbose mode
+CTAGS_OPTS = -V
+```
+
+**Requirement:** *Optional*
+
+----
+
+### CTAGS_CMD
+
+**Description:**
+
+Location of `ctags` binary. Defaults to user path.
+
+**Example:**
+
+```Makefile
+CTAGS_CMD = /usr/local/bin/
+```
+
+**Requirement:** *Optional*
+
+----
+
### MPIDE_PREFERENCES_PATH
**Description:**