aboutsummaryrefslogtreecommitdiff
path: root/docs/faq_debug.md
Commit message (Collapse)AuthorAgeFilesLines
* [Core] get_keycode_string(): function to format keycodes as strings, for ↵Pascal Getreuer2025-03-191-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | more readable debug logging. (#24787) * keycode_string(): Format keycodes as strings. This adds the `keycode_string()` function described in https://getreuer.info/posts/keyboards/keycode-string/index.html as a core feature. * Fix formatting. * keycode_string review revisions. * Rename keycode_string() -> get_keycode_string() for consistency with existing string utils like get_u8_str(). * Revise custom keycode names with separate _user and _kb tables. * Correct indent in builddefs/generic_features.mk. Co-authored-by: Ryan <[email protected]> * Add KC_NUHS, KC_NUBS, and KC_CAPS. * Fix linking error with custom names. * Attempt at simplifying interface. * Formatting fix. * Several fixes and revisions. * Don't use PSTR in KEYCODE_STRING_NAME, since this fails to build on AVR. Store custom names in RAM. * Revise the internal table of common keycode names to use its own storage representation, still in PROGMEM, and now more efficiently stored flat in 8 bytes per entry. * Support Swap Hands keycodes and a few other keycodes. * Revert "Formatting fix." This reverts commit 2a2771068c7ee545ffac4103aa07e847a9ec3816. * Revert "Attempt at simplifying interface." This reverts commit 8eaf67de76e75bc92d106a8b0decc893fbc65fa5. * Simplify custom names API by sigprof's suggestion. * Support more keycodes. * Add QK_LOCK keycode. * Add Secure keycodes. * Add Joystick keycodes. * Add Programmable Button keycodes. * Add macro MC_ keycodes. * For remaining keys in known code ranges, stringify them as "QK_<feature>+<number>". For instance, "QK_MIDI+7". * Bug fix and a few improvements. * Fix missing right-hand bit when displaying 5-bit mods numerically. * Support KC_HYPR, KC_MEH, HYPR_T(kc), MEH_T(kc). * Exclude one-shot keycodes when NO_ACTION_ONESHOT is defined. --------- Co-authored-by: Ryan <[email protected]>
* Fix link to TMK magic commands (#24773)Tocho Tochev2025-01-021-1/+1
|
* [docs] Organize driver & feature docs into subfolders (#23848)Ryan2024-06-021-1/+1
| | | | Co-authored-by: Nick Brassel <[email protected]>
* Vitepress conversion of docs. (#23795)0.25.2Nick Brassel2024-05-301-6/+6
|
* Remove legacy Debug keycode (#18769)Ryan2022-10-191-1/+1
| | | | | | | | | | | * `DEBUG` -> `DB_TOGG`, default-ish keymaps * `DEBUG` -> `DB_TOGG`, user keymaps * `DEBUG` -> `DB_TOGG`, community layouts * `DEBUG` -> `DB_TOGG`, userspace * `DEBUG` -> `DB_TOGG`, docs & core
* [Docs] Add a note about the print function. (#17737)Kim Minjong2022-10-041-0/+1
| | | Co-authored-by: Ryan <[email protected]>
* [Docs] Fix custom debug function and sample output (#17790)Drashna Jaelre2022-07-251-7/+7
|
* doc/faq_debug: qmk cli can also be used to print debug messages (#15528)Thomas Lorblanchès2021-12-221-2/+6
|
* [Docs] Clean up some code block languages (#14434)Ryan2021-09-141-2/+2
|
* Allow output of logging when running unit tests (#13556)0.13.26Joel Challis2021-07-251-1/+1
| | | | | | | | | | | * Initial pass at enabling logging for unit tests * Add to docs * Bind debug for more test types * Force everything * Tidy up slightly
* Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665)individ-divided2021-03-031-0/+13
| | | Co-authored-by: David Grundberg <david@quartz>
* Fix typos and reword some sentences in FAQs (#11546)smiley2021-01-231-7/+6
| | | | | | | | | * Fix minor typo in "General FAQ" "want to do brand it with QMK" -> "want to brand it with QMK" * Reword some of "Debugging FAQ" & "Miscellaneous FAQ". Mostly grammatical wording of some parts and missing capitalization
* Small tweaks to docs to make them more user friendly (#11518)Joel Challis2021-01-201-109/+80
| | | | | | | | | | | | | | | * first pass * firmware firmware? * Split out debug + testing docs * tidy up duplicate css * Add extra info to debug example Co-authored-by: Drashna Jaelre <[email protected]> Co-authored-by: Drashna Jaelre <[email protected]>
* Add TMK "FEED" VID to list of deprecated udev rulesfauxpark2020-09-191-14/+0
|
* Remove Atmel FLIP from install scripts and documentation (#8822)0.8.123Ryan2020-04-171-7/+0
|
* [Docs] Remove some outdated FAQ items (#7607)fauxpark2019-12-111-68/+0
|
* [Docs] Modified the description about setting debug_enable in ↵Takeshi ISHII2019-11-171-1/+1
| | | | `docs/faq_debug.md`. (#7394)
* Remove superfluous JTAG disable code (#6445)0.6.455fauxpark2019-08-201-12/+5
| | | | | | | | | | | | | | | | | | * Remove superfluous JTAG disable code * 32A has differently named register * Accidentally some operators * 32A also has different JTAG pins * Wrap disable_jtag() in an ifndef * Document this new define * Rename the define, it conflicts with a LUFA thing Also, move the ifndef wrapping to the call in keyboard_setup()
* [Docs] Fix indented subheading on faq_debug.md (#6320)noroadsleft2019-07-131-0/+1
|
* Trim trailing whitespacefauxpark2017-12-091-9/+9
|
* Fix some of the more obvious typosfauxpark2017-12-091-8/+8
|
* Convert all headings to Title Casefauxpark2017-12-091-15/+15
|
* Document the Teensy hardware reset problemErin Call2017-11-121-0/+1
|
* Fixed typo in docs. (#1818)lyuts2017-10-061-1/+1
|
* Doc updates from going through every fileskullY2017-08-161-0/+39
|
* Overhaul the Getting Started section and add a FAQ sectionskullY2017-08-161-0/+203