Files
bare-operating-system/developer-guide/kernel-explain-and-doctor-conventions.md
T
2026-04-25 23:04:56 -04:00

659 B

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.