summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTakeshi ISHII <2170248+mtei@users.noreply.github.com>2022-02-07 02:37:59 +0900
committerGitHub <noreply@github.com>2022-02-06 17:37:59 +0000
commit87199eb2f50522b7b91352e4b1c76d6db3f14af3 (patch)
tree6cb374a34ddc2cfd1ee3b7672598889e4ded768b
parent14f886d03bead5022d1a3ebcc72c75ae1f2b622e (diff)
add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247)
Added info_config.h added in #10817 to the include order description of config.h.
-rw-r--r--docs/data_driven_config.md2
-rw-r--r--docs/hardware_keyboard_guidelines.md1
2 files changed, 2 insertions, 1 deletions
diff --git a/docs/data_driven_config.md b/docs/data_driven_config.md
index c2ad4fed8f..38fb5dbf14 100644
--- a/docs/data_driven_config.md
+++ b/docs/data_driven_config.md
@@ -74,7 +74,7 @@ Whenever QMK generates a complete `info.json` it extracts information from `conf
If you are not sure how to edit this file or are not comfortable with Python [open an issue](https://github.com/qmk/qmk_firmware/issues/new?assignees=&labels=cli%2C+python&template=other_issues.md&title=) or [join #cli on Discord](https://discord.gg/heQPAgy) and someone can help you with this part.
-### Add code to generate it
+### Add code to generate it :id=add-code-to-generate-it
The final piece of the puzzle is providing your new option to the build system. This is done by generating two files:
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md
index be55356b17..6df86fb0fb 100644
--- a/docs/hardware_keyboard_guidelines.md
+++ b/docs/hardware_keyboard_guidelines.md
@@ -87,6 +87,7 @@ The `config.h` files can also be placed in sub-folders, and the order in which t
* `keyboards/top_folder/sub_1/sub_2/config.h`
* `keyboards/top_folder/sub_1/sub_2/sub_3/config.h`
* `keyboards/top_folder/sub_1/sub_2/sub_3/sub_4/config.h`
+ * [`.build/objs_<keyboard>/src/info_config.h`](data_driven_config.md#add-code-to-generate-it) see [Data Driven Configuration](data_driven_config.md)
* `users/a_user_folder/config.h`
* `keyboards/top_folder/keymaps/a_keymap/config.h`
* `keyboards/top_folder/sub_1/sub_2/sub_3/sub_4/post_config.h`