armbian/documentation
0
0
Fork 0
mirror of https://github.com/armbian/documentation.git synced 2026-01-06 10:13:36 -08:00
Code Issues Packages Projects Releases Wiki Activity

Document the process of skipping/ignoring/opting-out of an individual hook function (#842)

Browse Source 
related to armbian/build#8897
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
This commit is contained in:
tabrisnet
2025-11-16 16:01:13 -05:00
committed by GitHub
parent 966b97e91f
commit 458838c1d0
2 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/Developer-Guide_Extensions-Hooks.md
View File

@@ -5,6 +5,7 @@
## Hooks
- Hooks are listed in the order they are called.
- Individual/specific hook functions can be [skipped/ignored/opted-out](/Developer-Guide_Extensions#opt-out-of-individual-hook-functions).
### `post_family_config`

10
docs/Developer-Guide_Extensions.md
View File

@@ -97,3 +97,13 @@ They're the same, except:
- Directory-based extensions will be passed a `${EXTENSION_DIR}` environment variable.
- That is useful if there are other files/assets that belong together with that extension. An example would be a template file, some configuration file, or other static asset that is directly related to the extension.
- Using directory-based extensions and `${EXTENSION_DIR}` allows for easy moving and PR'ing of user extensions.
# Opt-out of individual hook functions
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
```bash
unset -f hook_name__individual_function
```
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.