Skip to content

docs: explain the hook count vs the diagnostic check count - #355

Open
okhsunrog wants to merge 2 commits into
mainfrom
docs/hooks-vs-checks
Open

okhsunrog wants to merge 2 commits into
mainfrom
docs/hooks-vs-checks

Conversation

@okhsunrog

Copy link
Copy Markdown
Owner

A user on a 4.14 device (where the partial-hooks false alarm was just fixed) asked two follow-up questions: why the backend card reads "hooks: 10" rather than 11, and why the detailed Diagnostics screen lists more entries (15 native, 13 Java) than the hook counts. Both are expected; document them where each number is shown.

  • docs/diagnostics.md (contributor reference): a new "Hook count vs check count" section — installed interception points vs probed detection vectors are different denominators, related many-to-many (one hook covers several checks, one check can be covered by several hooks across backends, some checks pass with no installed hook via SELinux / the CAP_NET_RAW gate / the optional Zygisk group).
  • docs/help/*/statistics.md (user guide): "10 hooks" is a complete install on kernels before 5.3, where the kernel's own gate covers the bind hook — not a "10 of 11" defect — plus a pointer that the hook count is not the check count.
  • docs/help/*/what-the-check-proves.md (user guide): why the check count isn't the hook count. All three locales (en/ru/zh).

No code, no new help article — the existing self-test and statistics articles already cover this area, so the notes go there. Docs-only, no changelog entry.

A user on a 4.14 device asked why Statistics shows "KPM OK · hooks: 10" while the
detailed diagnostics lists 15 KPM checks (and 8 vs 13 for LSPosed). Document that
these are different denominators — installed interception points vs probed
detection vectors — related many-to-many: one hook covers several checks, one
check can be covered by several hooks across backends, and some checks pass with
no installed hook (SELinux, the CAP_NET_RAW gate, or the optional Zygisk group).
The self-test measures outcomes per vector, not one probe per hook.
@github-actions github-actions Bot added the area:docs Documentation only label Sep 18, 2026
A user on a 4.14 device asked why the KPM backend shows "hooks: 10". Put it on
the KPM page (kpm-install.md), where kernel-specific behaviour belongs: on kernels
before 5.3 the backend installs 10 hooks, not 11, and reads OK — a complete
install, because the kernel's own gate covers the bind hook there (5.3+ installs
all 11). what-the-check-proves.md keeps the note that the Diagnostics check count
is not the hook count. All three locales.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant