diff options
| author | skullydazed <skullydazed@users.noreply.github.com> | 2020-01-24 11:31:16 -0800 |
|---|---|---|
| committer | Erovia <Erovia@users.noreply.github.com> | 2020-01-24 20:31:16 +0100 |
| commit | 5e65af3a76252bea6556d26add3061dea4918cc2 (patch) | |
| tree | f44089f3f95e53e1b67d34db3c922a04b0a942f7 /docs | |
| parent | e4a0f841e19b4ddf86711cf79dc521d2f6f5e4ae (diff) | |
Beef up how `qmk doctor` works. (#7375)
* Beef up how `qmk doctor` works.
* improve the `git submodule status` parsing. h/t @erovia
* Fix whitespace and imports
* yapf
* Add documentation for the new doctor functionality
* Replace type_unchanged() with str()
* remove unused modules
* Update lib/python/qmk/cli/doctor.py
Co-Authored-By: Erovia <Erovia@users.noreply.github.com>
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cli.md | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/cli.md b/docs/cli.md index 1c09527221..4f328a75a2 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -141,14 +141,28 @@ qmk docs [-p PORT] ## `qmk doctor` -This command examines your environment and alerts you to potential build or flash problems. +This command examines your environment and alerts you to potential build or flash problems. It can fix many of them if you want it to. **Usage**: ``` -qmk doctor +qmk doctor [-y] [-n] ``` +**Examples**: + +Check your environment for problems and prompt to fix them: + + qmk doctor + +Check your environment and automatically fix any problems found: + + qmk doctor -y + +Check your environment and report problems only: + + qmk doctor -n + ## `qmk json-keymap` Creates a keymap.c from a QMK Configurator export. |