Files
RedBear-OS/docs/AGENTS.md
T
vasilito 6d8ef13dc1 LG Gram Round 1: redox-driver-sys stub replacements + doc reference fixes
Round 1 of the LG Gram 16Z90TP compatibility work. Two parallel
workstreams in one commit:

1. Stub replacements in redox-driver-sys (per project zero-tolerance
   policy):

   - load_dmi_acpi_quirks() (was hardcoded AcpiQuirkFlags::empty()):
     real loader walking a new compiled-in DMI_ACPI_QUIRK_RULES table
     (currently empty — documented why) plus a new [[dmi_acpi_quirk]]
     TOML section parser in toml_loader.rs. The full 16-flag
     ACPI_FLAG_NAMES mapping is added so TOML entries can use any
     AcpiQuirkFlags variant by name.

   - PANEL_ORIENTATION_TABLE (was empty placeholder): populated with
     10 real entries ported from Linux 7.x
     drivers/gpu/drm/drm_panel_orientation.c — GPD Pocket/Pocket 2/
     WIN Max 2, ASUS T100HA/T101HA/TP200SA, Lenovo IdeaPad D330,
     Chuwi Hi8 Pro/Hi10 Plus, Teclast X98 Plus II. Each entry cites
     its Linux source commit.

   - PLATFORM_RULES (kept empty): documented why intentionally empty
     (Linux platform-wide DMI quirks are pre-2020 platform workarounds
     not needed by Red Bear's modern targets).

2. Broken reference fixes after the 2026-07-25 archive
   (commit 589a1044e6 moved 9 docs to legacy-obsolete-2026-07-25/
   but didn't update references). 30+ files referenced the moved
   docs by their old local/docs/<name>.md path. This commit updates
   every reference to point at local/docs/legacy-obsolete-2026-07-25/
   <name>.md so links work again. Files touched: AGENTS.md,
   README.md, docs/{AGENTS,README,07-RED-BEAR-OS-IMPLEMENTATION-PLAN}.md,
   local/AGENTS.md, 14 docs under local/docs/, local/patches/README.md,
   5 scripts under local/scripts/.

The matching acpid+ps2d consumer wiring landed earlier today in
submodule/base commit 45452c5a (force_s2idle, no_legacy_pm1b,
kbd_deactivate_fixup). The bootstrap reference fix is submodule/base
commit 263a41a9. Both are tracked by the updated submodule pointer
in this commit.

Build verification: redox-driver-sys 80 cargo tests pass. acpid/ps2d
host tests not runnable (require cross-compile). Canonical build
attempts uncovered two pre-existing failures unrelated to Round 1:
relibc edition-2024 unsafe-block issue in crtn, and the base fork's
'common' path resolution relies on the build script's overlay
integrity auto-repair which is currently failing. Neither is in code
touched by Round 1.

See local/docs/evidence/lg-gram/ASSESSMENT-2026-07-26.md for the full
round-by-round assessment and next-round plan.
2026-07-26 16:59:32 +09:00

3.4 KiB

DOCS — ARCHITECTURE & INTEGRATION DOCUMENTATION

Public docs/ files now mix three roles:

  • canonical repository-level policy/current-state docs,
  • architecture/reference docs,
  • and older roadmap/design docs that are still useful but partly historical.

Do not assume everything under docs/ is equally current.

For current Red Bear OS status, also read:

  • docs/README.md — canonical docs index + status matrix
  • docs/07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md — canonical public implementation plan
  • local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.mdcanonical comprehensive implementation plan — all current state
  • local/docs/legacy-obsolete-2026-07-25/DRM-MODERNIZATION-EXECUTION-PLAN.md — current DRM-focused execution plan beneath the canonical desktop path
  • local/docs/SCRIPT-BEHAVIOR-MATRIX.md — current script guarantees and non-guarantees

STRUCTURE

docs/
├── 01-REDOX-ARCHITECTURE.md   # Architecture reference: microkernel, scheme system, driver model, display architecture
├── 04-LINUX-DRIVER-COMPAT.md  # Driver-compat architecture reference + historical porting path
├── 05-KDE-PLASMA-ON-REDOX.md  # Historical KDE implementation path + deeper rationale
├── 06-BUILD-SYSTEM-SETUP.md   # Build/setup mechanics guide (not canonical policy)
├── 07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md # Canonical public implementation plan
└── README.md                  # Canonical docs index + status matrix

WHERE TO LOOK

Question Document Key Section
How does the kernel work? 01 §1 Microkernel, §2 Scheme System
How do drivers access hardware? 01 §3 Driver Model, §6 Build System
What is the canonical current implementation plan? 07 Entire document
Which docs are current vs historical? README Document Status Matrix
What is the current WIP ownership policy? local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md Current state and blocker map
What do the main sync/fetch/apply/build scripts actually guarantee? local/docs/SCRIPT-BEHAVIOR-MATRIX.md Entire document
What is the current desktop-stack truth? local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md Entire document
What is the current Wi-Fi architecture and validation path? local/docs/WIFI-IMPLEMENTATION-PLAN.md Entire document
What's missing for Wayland? local/docs/WAYLAND-IMPLEMENTATION-PLAN.md Entire document
What is the current Wayland plan? local/docs/WAYLAND-IMPLEMENTATION-PLAN.md Entire document
How to run Linux GPU drivers? 04 Architecture diagram, i915 porting example
What is redox-driver-sys? 04 Crate 1: memory, IRQ, PCI, DMA wrappers
What is linux-kpi? 04 Crate 2: C headers translating Linux→Redox APIs
How to port Qt? 05 Phase KDE-A (qtbase patches, ~500-800 lines)
How to port KDE Frameworks? 05 Phase KDE-B (25 frameworks, tiered approach)
How to port KDE Plasma? 05 Phase KDE-C (KWin, Plasma Shell, session config)
How to set up the build? 06 Prerequisites per distro, build commands
What is the current work ordering? 07 Workstream Order + Blocker chain
How to fix POSIX gaps in relibc? local/docs/KERNEL-IPC-CREDENTIAL-PLAN.md Implemented credential syscalls

READING RULE

When a current-state local document conflicts with an older public roadmap/design file, prefer the current local subsystem plan or the canonical public implementation plan.