aboutsummaryrefslogtreecommitdiff
path: root/docs/config_options.md
diff options
context:
space:
mode:
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
12 12
13// config options 13// config options
14 14
15#ifdef SUBPROJECT_<subproject>
16 #include "<subproject>/config.h"
17#endif
18
19#endif 15#endif
20``` 16```
21 17
22This 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. 18This 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.
23 19
24## Subproject 20## Revisions
25 21
26```c 22```c
27#ifndef <subproject>_CONFIG_H 23#ifndef <revision>_CONFIG_H
28#define <subproject>_CONFIG_H 24#define <revision>_CONFIG_H
29 25
30#include "../config.h" 26#include "config_common.h"
31 27
32// config options 28// config options
33 29
34#endif 30#endif
35``` 31```
36 32
37For keyboards that have subprojects, this file contains config options that should apply to only that subproject, and won't change in most keymaps. 33For keyboards that have revisions, this file contains config options that should apply to only that revisions, and won't change in most keymaps.
38 34
39## Keymap 35## Keymap
40 36
@@ -42,7 +38,7 @@ For keyboards that have subprojects, this file contains config options that shou
42#ifndef CONFIG_USER_H 38#ifndef CONFIG_USER_H
43#define CONFIG_USER_H 39#define CONFIG_USER_H
44 40
45#include "../../config.h" 41#include "config_common.h"
46 42
47// config options 43// config options
48 44