Deploying to gh-pages from master @ 88fe5c16a5 🚀
				
					
				
			This commit is contained in:
		
							parent
							
								
									c34eb456b9
								
							
						
					
					
						commit
						e5cab0b3cf
					
				
					 95 changed files with 2232 additions and 750 deletions
				
			
		| 
						 | 
				
			
			@ -382,6 +382,33 @@ qmk format-c
 | 
			
		|||
qmk format-c -b branch_name
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## `qmk generate-compilation-database`
 | 
			
		||||
 | 
			
		||||
**Usage**:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
qmk generate-compilation-database [-kb KEYBOARD] [-km KEYMAP]
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Creates a `compile_commands.json` file.
 | 
			
		||||
 | 
			
		||||
Does your IDE/editor use a language server but doesn't _quite_ find all the necessary include files? Do you hate red squigglies? Do you wish your editor could figure out `#include QMK_KEYBOARD_H`? You might need a [compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html)! The qmk tool can build this for you.
 | 
			
		||||
 | 
			
		||||
This command needs to know which keyboard and keymap to build. It uses the same configuration options as the `qmk compile` command: arguments, current directory, and config files.
 | 
			
		||||
 | 
			
		||||
**Example:**
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
$ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak
 | 
			
		||||
$ qmk generate-compilation-database
 | 
			
		||||
Ψ Making clean
 | 
			
		||||
Ψ Gathering build instructions from make -n gh60/satan:colemak
 | 
			
		||||
Ψ Found 50 compile commands
 | 
			
		||||
Ψ Writing build database to /Users/you/src/qmk_firmware/compile_commands.json
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Now open your dev environment and live a squiggly-free life.
 | 
			
		||||
 | 
			
		||||
## `qmk docs`
 | 
			
		||||
 | 
			
		||||
This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936.
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue