10 lines
659 B
Markdown
10 lines
659 B
Markdown
# Kernel doctor and `kernel-explain` conventions
|
|
|
|
Stock `/bin/kernel-doctor`, `/bin/kernel-explain`, and related tools should emit **structured, stable** objects for operators:
|
|
|
|
- Prefer **JSON** with a top-level **`schema`** integer and **`kind`** string (`boot`, `vfs`, `policy`, `extension`, …).
|
|
- Human-oriented **`message`** plus machine **`code`** (stable identifier, `SCREAMING_SNAKE` or dotted namespace).
|
|
- Never include **secrets** (keys, tokens, raw vault bytes); redact paths under personal drive if policy requires.
|
|
|
|
When adding a new diagnostic surface, update **handbook**, **users-manual** troubleshooting, and **docs/reference** proc maps.
|