Update the documentation around opting out of an individual hook function

[tabrisnet]

update from #842 in re armbian/build#9178.
basically we no longer use unset -f directly, but instead use extension_hook_opt_out

[coderabbitai]

Walkthrough

This pull request updates Developer Guide Extensions documentation to change the recommended opt-out method for individual hook functions. The prior example using unset -f hook_name__individual_function is replaced with extension_hook_opt_out "hook_name__individual_function". An advisory paragraph was added explaining users may opt out and optionally copy/modify the function in their own config, while still recommending splitting intolerable functionality into separate functions. A link target in the Hooks doc was updated to point to the new opt-out section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Document the process of skipping/ignoring/opting-out of an individual hook function #842 — Earlier documentation discussing opt-out approaches; this PR replaces the unset -f example with the new extension_hook_opt_out mechanism.

Suggested reviewers

• igorpecovnik

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: updating documentation to reflect a new opt-out mechanism for extension hook functions.
Description check	✅ Passed	The description is related to the changeset, referencing the transition from unset -f to extension_hook_opt_out and linking to relevant issues.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between e916be6 and 7665ee0.

📒 Files selected for processing (2)

• docs/Developer-Guide_Extensions-Hooks.md
• docs/Developer-Guide_Extensions.md

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/Developer-Guide_Extensions.md

🔇 Additional comments (1)

docs/Developer-Guide_Extensions-Hooks.md (1)

8-8: The new link anchor #how-to-opt-out-of-a-specific-hook-function exists in docs/Developer-Guide_Extensions.md at line 109 as a level-4 heading ("How to opt out of a specific hook function?"), so the link reference is valid and will not result in a broken link. The change is correct.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/Developer-Guide_Extensions.md (1)

109-118: Fix grammatical awkwardness on line 117.

The documentation properly documents the new extension_hook_opt_out function as the mechanism for skipping extension hook functions, replacing the previous unset -f approach. The additional guidance about copying and modifying functions adds useful context.

One grammatical issue: Line 117 repeats "doing so" which reads awkwardly. Reword to: "Doing so is at the board/family maintainer's own risk and is officially unsupported."

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 553ba1d and 19bae9f.

📒 Files selected for processing (1)

• docs/Developer-Guide_Extensions.md

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/Developer-Guide_Extensions.md (1)

117-118: Minor: Reduce repetition in advisory text.

The phrase "doing so" is used twice in line 117 ("Doing so is at the board/family maintainer's own risk and doing so is officially unsupported"), which is slightly redundant. Consider consolidating for tighter prose:

✍️ Suggested wording refinement

-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.
+This 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.

The added advisory on line 118 about copying and modifying the function is helpful and provides practical flexibility while maintaining the recommendation for function splitting.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 19bae9f and fd8549a.

📒 Files selected for processing (2)

• docs/Developer-Guide_Extensions-Hooks.md
• docs/Developer-Guide_Extensions.md

✅ Files skipped from review due to trivial changes (1)

• docs/Developer-Guide_Extensions-Hooks.md

🔇 Additional comments (1)

docs/Developer-Guide_Extensions.md (1)

109-115: Clear explanation of the new opt-out mechanism.

The documentation correctly replaces the deprecated unset -f approach with the new extension_hook_opt_out function. The syntax is properly formatted with appropriate quoting, and the context makes it easy for users to understand when and how to use this mechanism.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/Developer-Guide_Extensions.md (1)

109-118: Documentation update is clear and well-structured.

The change properly implements the new recommended approach using extension_hook_opt_out and includes appropriate risk warnings and alternatives. The section is well-positioned for users seeking this information.

Minor suggestion: On line 118, consider removing the hyphen from "intolerable-function" to match the phrasing on line 117 ("the part the board/family cannot tolerate"). This small adjustment would improve consistency in terminology throughout the advisory.

Minor consistency improvement (optional)

- 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.
+ 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.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between fd8549a and e916be6.

📒 Files selected for processing (1)

• docs/Developer-Guide_Extensions.md