aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2020-03-16 14:27:19 +0000
committerGitHub <noreply@github.com>2020-03-16 14:27:19 +0000
commit19dbcf38149a2ba9a51935aae36c276a6dbd4b01 (patch)
treef3f37cc761bb02a1fdb06a21e403113d44f9bfad
parentc89012566c9f542b1bff8f3ffd9dded5175cc41f (diff)
downloadqmk_firmware-19dbcf38149a2ba9a51935aae36c276a6dbd4b01.tar.gz
qmk_firmware-19dbcf38149a2ba9a51935aae36c276a6dbd4b01.zip
Document 'make all:<name>' (#8439)
* Document 'make all:<name>' * add cli docs * Apply suggestions from code review Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
-rw-r--r--docs/cli_commands.md6
-rw-r--r--docs/feature_userspace.md20
2 files changed, 22 insertions, 4 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index bffa8263e..eb5362bd2 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -57,6 +57,12 @@ Must be in keyboard directory with a default keymap, or in keymap directory for
57qmk compile 57qmk compile
58``` 58```
59 59
60**Usage for building all keyboards that support a specific keymap**:
61
62```
63qmk compile -kb all -km <keymap_name>
64```
65
60**Example**: 66**Example**:
61``` 67```
62$ qmk config compile.keymap=default 68$ qmk config compile.keymap=default
diff --git a/docs/feature_userspace.md b/docs/feature_userspace.md
index a2657c1f6..ac0a1360d 100644
--- a/docs/feature_userspace.md
+++ b/docs/feature_userspace.md
@@ -97,13 +97,25 @@ You'd want to replace the year, name, email and github username with your info.
97 97
98Additionally, this is a good place to document your code, if you wish to share it with others. 98Additionally, this is a good place to document your code, if you wish to share it with others.
99 99
100# Examples 100## Build All Keyboards That Support a Specific Keymap
101
102Want to check all your keymaps build in a single command? You can run:
103
104 make all:<name>
105
106For example,
107
108 make all:jack
109
110This is ideal for when you want ensure everything compiles successfully when preparing a [_Pull request_](https://github.com/qmk/qmk_firmware/pulls).
111
112## Examples
101 113
102For a brief example, checkout [`/users/_example/`](https://github.com/qmk/qmk_firmware/tree/master/users/drashna). 114For a brief example, checkout [`/users/_example/`](https://github.com/qmk/qmk_firmware/tree/master/users/drashna).
103For a more complicated example, checkout [`/users/drashna/`](https://github.com/qmk/qmk_firmware/tree/master/users/drashna)'s userspace. 115For a more complicated example, checkout [`/users/drashna/`](https://github.com/qmk/qmk_firmware/tree/master/users/drashna)'s userspace.
104 116
105 117
106## Customized Functions 118### Customized Functions
107 119
108QMK has a bunch of [functions](custom_quantum_functions.md) that have [`_quantum`, `_kb`, and `_user` versions](custom_quantum_functions.md#a-word-on-core-vs-keyboards-vs-keymap) that you can use. You will pretty much always want to use the user version of these functions. But the problem is that if you use them in your userspace, then you don't have a version that you can use in your keymap. 120QMK has a bunch of [functions](custom_quantum_functions.md) that have [`_quantum`, `_kb`, and `_user` versions](custom_quantum_functions.md#a-word-on-core-vs-keyboards-vs-keymap) that you can use. You will pretty much always want to use the user version of these functions. But the problem is that if you use them in your userspace, then you don't have a version that you can use in your keymap.
109 121
@@ -130,7 +142,7 @@ The `_keymap` part here doesn't matter, it just needs to be something other than
130 142
131You can see a list of this and other common functions in [`template.c`](https://github.com/qmk/qmk_firmware/blob/master/users/drashna/template.c) in [`users/drashna`](https://github.com/qmk/qmk_firmware/tree/master/users/drashna). 143You can see a list of this and other common functions in [`template.c`](https://github.com/qmk/qmk_firmware/blob/master/users/drashna/template.c) in [`users/drashna`](https://github.com/qmk/qmk_firmware/tree/master/users/drashna).
132 144
133## Custom Features 145### Custom Features
134 146
135Since the Userspace feature can support a staggering number of boards, you may have boards that you want to enable certain functionality for, but not for others. And you can actually create "features" that you can enable or disable in your own userspace. 147Since the Userspace feature can support a staggering number of boards, you may have boards that you want to enable certain functionality for, but not for others. And you can actually create "features" that you can enable or disable in your own userspace.
136 148
@@ -166,7 +178,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
166``` 178```
167 179
168 180
169## Consolidated Macros 181### Consolidated Macros
170 182
171If you wanted to consolidate macros and other functions into your userspace for all of your keymaps, you can do that. This builds upon the [Customized Functions](#customized-functions) example above. This lets you maintain a bunch of macros that are shared between the different keyboards, and allow for keyboard specific macros, too. 183If you wanted to consolidate macros and other functions into your userspace for all of your keymaps, you can do that. This builds upon the [Customized Functions](#customized-functions) example above. This lets you maintain a bunch of macros that are shared between the different keyboards, and allow for keyboard specific macros, too.
172 184