Skip to content

Commit 93f8e31

Browse files
authored
Update the documentation around opting out of an individual hook function (#864)
1 parent 553ba1d commit 93f8e31

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

docs/Developer-Guide_Extensions-Hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
## Hooks
66

77
- Hooks are listed in the order they are called.
8-
- Individual/specific hook functions can be [skipped/ignored/opted-out](/Developer-Guide_Extensions#opt-out-of-individual-hook-functions).
8+
- Individual/specific hook functions can be [skipped/ignored/opted-out](/Developer-Guide_Extensions#how-to-opt-out-of-a-specific-hook-function).
99

1010
### `post_family_config`
1111

docs/Developer-Guide_Extensions.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@ They're the same, except:
111111
Any function making use of the extension framework [generally of the form `hook_name__individual_function`] can be skipped in a board or family config, by way of
112112

113113
```bash
114-
unset -f hook_name__individual_function
114+
extension_hook_opt_out "hook_name__individual_function"
115115
```
116116

117-
Doing so is at the board/family maintainer's own risk and doing so is officially unsupported. Consider splitting the function into pieces so that only the part the board/family cannot tolerate is skipped.
117+
Doing so is at the board/family maintainer's own risk and is officially unsupported. Consider splitting the function into pieces so that only the part the board/family cannot tolerate is skipped.
118+
You can also opt out, then copy the otherwise-intolerable function into your own config and modify it as appropriate. Splitting the intolerable-function is still highly recommended.

0 commit comments

Comments
 (0)