Unify Tap Hold functions and documentation #8348

drashna · 2020-03-09T03:44:49Z

Updates all of the per key functions, and the documentation to go with them.

Specifically, this means that the keyrecord_t structure has been added to the function call for get_tapping_term, mostly.

Additionally, this moves all of the references in the documentation to the tap_hold.md doc, for easy access.

This does update a number of user keymaps, and significantly changes a function parameter in core code, so marked as a breaking change.

Types of Changes

Core
Enhancement/optimization
Documentation

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

ridingqwerty

Nice 👍

docs/tap_hold.md

docs/ChangeLog/20200530/PR8348.md

noroadsleft · 2020-04-29T17:54:46Z

docs/ChangeLog/20200530/PR8348.md needs user instructions for fixing broken keymaps/code IMO.

drashna · 2020-04-30T04:41:49Z

docs/ChangeLog/20200530/PR8348.md needs user instructions for fixing broken keymaps/code IMO.

Sounds good to me.

Something like?

Any keymaps that have not been updated (such as those not in the repo), or that are otherwise erroring out on these functions need to be updated to appear like this:
 
uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record)
bool get_permissive_hold(uint16_t keycode, keyrecord_t *record)
bool get_ignore_mod_tap_interrupt(uint16_t keycode, keyrecord_t *record)
bool get_tapping_force_hold(uint16_t keycode, keyrecord_t *record)

Edit: Ran another pass on the repo, found a couple boards that had made it in since. Fixed them. Also found a couple of errors in the documentation that needed to be addressed.

Co-Authored-By: James Young <[email protected]>

noroadsleft · 2020-04-30T06:44:10Z

Something like?

Any keymaps that have not been updated (such as those not in the repo), or that are otherwise erroring out on these functions need to be updated to appear like this:
 
uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record)
bool get_permissive_hold(uint16_t keycode, keyrecord_t *record)
bool get_ignore_mod_tap_interrupt(uint16_t keycode, keyrecord_t *record)
bool get_tapping_force_hold(uint16_t keycode, keyrecord_t *record)

That looks okay to me, but IMO a table that shows both the old and the new syntax would be better.

drashna · 2020-05-01T08:11:13Z

Added. And double checked, only get_tapping_term and get_permissive_hold need to be updated.

noroadsleft · 2020-05-01T19:50:10Z

Thanks!

* Update and combined Tap Hold documentation * Modify per key tapping functions to include keyrecord * Fix call for get_tapping_term * Update non-english docs * Update user keymaps * No kb/user documentation * Breaking Changes Changelog * Wordsmithing from noroads * Fix typos in docs * Run another search for old function * Add table for conversion

* Branch point for 2020 May 30 Breaking Change * Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954) * Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957) * Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958) * Migrate `ACTION_LAYER_MODS` to `LM()` (#8959) * Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968) * Convert V-USB usbdrv to a submodule (#8321) * Unify Tap Hold functions and documentation (#8348) * Changing board names to prevent confusion (#8412) * Move the Keyboardio Model01 to a keyboardio/ subdir (#8499) * Move spaceman keyboards (#8830) * Migrate miscellaneous `fn_actions` entries (#8977) * Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979) * Organizing my keyboards (plaid, tartan, ergoinu) (#8537) * Refactor Lily58 to use split_common (#6260) * Refactor zinc to use split_common (#7114) * Add a message if bin/qmk doesn't work (#9000) * Fix conflicting types for 'tfp_printf' (#8269) * Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480) * Refactor and updates to TKC1800 code (#8472) * Switch to qmk forks for everything (#9019) * audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484) * Audio enable corrections (2/3) (#8903) * Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582) * Audio enable corrections (Part 4) (#8974) * Fix typo from PR7114 (#9171) * Augment future branch Changelogs (#8978) * Revert "Branch point for 2020 May 30 Breaking Change"

* Branch point for 2020 May 30 Breaking Change * Migrate `ACTION_LAYER_TOGGLE` to `TG()` (qmk#8954) * Migrate `ACTION_MODS_ONESHOT` to `OSM()` (qmk#8957) * Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (qmk#8958) * Migrate `ACTION_LAYER_MODS` to `LM()` (qmk#8959) * Migrate `ACTION_MODS_TAP_KEY` to `MT()` (qmk#8968) * Convert V-USB usbdrv to a submodule (qmk#8321) * Unify Tap Hold functions and documentation (qmk#8348) * Changing board names to prevent confusion (qmk#8412) * Move the Keyboardio Model01 to a keyboardio/ subdir (qmk#8499) * Move spaceman keyboards (qmk#8830) * Migrate miscellaneous `fn_actions` entries (qmk#8977) * Migrate `ACTION_MODS_KEY` to chained mod keycodes (qmk#8979) * Organizing my keyboards (plaid, tartan, ergoinu) (qmk#8537) * Refactor Lily58 to use split_common (qmk#6260) * Refactor zinc to use split_common (qmk#7114) * Add a message if bin/qmk doesn't work (qmk#9000) * Fix conflicting types for 'tfp_printf' (qmk#8269) * Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (qmk#6480) * Refactor and updates to TKC1800 code (qmk#8472) * Switch to qmk forks for everything (qmk#9019) * audio refactor: replace deprecated PLAY_NOTE_ARRAY (qmk#8484) * Audio enable corrections (2/3) (qmk#8903) * Split HHKB to ANSI and JP layouts and Add VIA support for each (qmk#8582) * Audio enable corrections (Part 4) (qmk#8974) * Fix typo from PR7114 (qmk#9171) * Augment future branch Changelogs (qmk#8978) * Revert "Branch point for 2020 May 30 Breaking Change"

drashna added core documentation breaking_change Changes that need to wait for a version increment labels Mar 9, 2020

drashna requested review from ridingqwerty, noroadsleft and a team March 9, 2020 03:44

ridingqwerty approved these changes Apr 6, 2020

View reviewed changes

drashna force-pushed the tap_hold/per_key branch 2 times, most recently from ad3ed1f to 34deb44 Compare April 13, 2020 01:39

drashna changed the base branch from master to future April 13, 2020 01:47

drashna changed the base branch from future to master April 13, 2020 01:54

noroadsleft requested changes Apr 28, 2020

View reviewed changes

docs/tap_hold.md Outdated Show resolved Hide resolved

docs/ChangeLog/20200530/PR8348.md Outdated Show resolved Hide resolved

drashna changed the base branch from master to future April 28, 2020 18:32

drashna requested a review from a team April 28, 2020 18:32

noroadsleft force-pushed the future branch from 4445fc5 to 43fa4c2 Compare April 29, 2020 17:02

drashna and others added 8 commits April 29, 2020 21:45

Update and combined Tap Hold documentation

ce5718b

Modify per key tapping functions to include keyrecord

1bec797

Fix call for get_tapping_term

e1ae30b

Update non-english docs

b22a4df

Update user keymaps

e1296ce

No kb/user documentation

68395d0

Breaking Changes Changelog

e012195

Wordsmithing from noroads

bad8380

Co-Authored-By: James Young <[email protected]>

drashna force-pushed the tap_hold/per_key branch from e9b2205 to 904ea20 Compare April 30, 2020 04:45

Fix typos in docs

17b78b4

drashna force-pushed the tap_hold/per_key branch from 904ea20 to 17b78b4 Compare April 30, 2020 04:49

Run another search for old function

f7fa361

Add table for conversion

4c77048

noroadsleft approved these changes May 1, 2020

View reviewed changes

noroadsleft merged commit f4fd7f0 into qmk:future May 1, 2020

noroadsleft added the future_2020q2 label May 1, 2020

sigprof mentioned this pull request May 3, 2020

[Bug] get_permissive_hold() logic is reversed #8999

Closed

sigprof mentioned this pull request May 6, 2020

[Feature Request] Permissive Hold and Ignore Mod Tap Interrupt for LT #8971

Closed

4 tasks

drashna deleted the tap_hold/per_key branch May 9, 2020 19:48

mtei mentioned this pull request Oct 11, 2020

[Bug] docs/feature_tap_dance.md link broken. #10613

Closed

precondition mentioned this pull request Oct 7, 2021

[Docs] Fix link from feature_tap_dance.md to tapping term settings #14741

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unify Tap Hold functions and documentation #8348

Unify Tap Hold functions and documentation #8348

drashna commented Mar 9, 2020

ridingqwerty left a comment

noroadsleft commented Apr 29, 2020

drashna commented Apr 30, 2020 •

edited

Loading

noroadsleft commented Apr 30, 2020

drashna commented May 1, 2020

noroadsleft commented May 1, 2020

Unify Tap Hold functions and documentation #8348

Unify Tap Hold functions and documentation #8348

Conversation

drashna commented Mar 9, 2020

Types of Changes

Checklist

ridingqwerty left a comment

Choose a reason for hiding this comment

noroadsleft commented Apr 29, 2020

drashna commented Apr 30, 2020 • edited Loading

noroadsleft commented Apr 30, 2020

drashna commented May 1, 2020

noroadsleft commented May 1, 2020

drashna commented Apr 30, 2020 •

edited

Loading