summaryrefslogtreecommitdiffstats
path: root/docs/config_options.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-10-14 23:32:19 +0200
committerGitHub <noreply@github.com>2017-10-14 23:32:19 +0200
commit800ec55dfca06b4630acf62cbb5f130c4031e4f1 (patch)
tree718e43d976bc71627558b5f9e1b657e8a64e4131 /docs/config_options.md
parente5dc2253e26a105a11e0fad3e4e39c306e49cc92 (diff)
downloadqmk_firmware-800ec55dfca06b4630acf62cbb5f130c4031e4f1.tar.gz
qmk_firmware-800ec55dfca06b4630acf62cbb5f130c4031e4f1.tar.xz
Make arguments redo, subproject elimination (#1784)
* redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * start to update readmes and keyboards * look in keyboard directories for board.mk * update visualizer rules * fix up some other keyboards/keymaps * fix arm board ld includes * fix board rules * fix up remaining keyboards * reset layout variable * reset keyboard_layouts * fix remainging keymaps/boards * update readmes, docs * add note to makefile error * update readmes * remove planck keymap warnings * update references and docs * test out tarvis build stages * don't use stages for now * don't use stages for now
Diffstat (limited to 'docs/config_options.md')
-rw-r--r--docs/config_options.md18
1 files changed, 7 insertions, 11 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index 13c8bdbbe..b71dbb8ae 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -12,29 +12,25 @@ This is a c header file that is one of the first things included, and will persi
// config options
-#ifdef SUBPROJECT_<subproject>
- #include "<subproject>/config.h"
-#endif
-
#endif
```
-This file contains config options that should apply to the whole keyboard, and won't change in subprojects, or most keymaps. The suproject block here only applies to keyboards with subprojects.
+This file contains config options that should apply to the whole keyboard, and won't change in revisions, or most keymaps. The revision block here only applies to keyboards with revisions.
-## Subproject
+## Revisions
```c
-#ifndef <subproject>_CONFIG_H
-#define <subproject>_CONFIG_H
+#ifndef <revision>_CONFIG_H
+#define <revision>_CONFIG_H
-#include "../config.h"
+#include "config_common.h"
// config options
#endif
```
-For keyboards that have subprojects, this file contains config options that should apply to only that subproject, and won't change in most keymaps.
+For keyboards that have revisions, this file contains config options that should apply to only that revisions, and won't change in most keymaps.
## Keymap
@@ -42,7 +38,7 @@ For keyboards that have subprojects, this file contains config options that shou
#ifndef CONFIG_USER_H
#define CONFIG_USER_H
-#include "../../config.h"
+#include "config_common.h"
// config options