From cd41c529823d3bb14165053fb5a0fac07476e307 Mon Sep 17 00:00:00 2001 From: Vasilito Date: Sun, 19 Apr 2026 17:57:20 +0100 Subject: [PATCH] Update public docs for four compile targets --- docs/06-BUILD-SYSTEM-SETUP.md | 34 +++++----- docs/07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md | 79 ++++++++-------------- docs/README.md | 10 +-- 3 files changed, 49 insertions(+), 74 deletions(-) diff --git a/docs/06-BUILD-SYSTEM-SETUP.md b/docs/06-BUILD-SYSTEM-SETUP.md index f01cb96d..bbda7104 100644 --- a/docs/06-BUILD-SYSTEM-SETUP.md +++ b/docs/06-BUILD-SYSTEM-SETUP.md @@ -99,17 +99,17 @@ echo 'PODMAN_BUILD?=0' > .config ### Select Build Configuration Mainline configs still exist, but tracked Red Bear work should normally be built and validated -through the tracked `redbear-*` profiles. For the desktop direction specifically, `redbear-kde` -is the tracked default target. +through the four supported `redbear-*` compile targets. For desktop work specifically, +`redbear-full` is the tracked desktop-capable target. Available configs (in `config/`): | Config | Description | |---|---| -| `redbear-minimal` | Minimal tracked Red Bear image | -| `redbear-full` | Broader tracked integration image | -| `redbear-kde` | Tracked default KWin Wayland image | -| `redbear-live` | Live image following the tracked desktop target | +| `redbear-mini` | Minimal tracked Red Bear image | +| `redbear-live-mini` | Live/recovery variant of the minimal target | +| `redbear-full` | Desktop-capable tracked Red Bear image | +| `redbear-live-full` | Live/recovery variant of the desktop-capable target | ## Building @@ -119,7 +119,7 @@ Available configs (in `config/`): make all ``` -This produces `build/x86_64/redbear-kde/harddrive.img`. +This produces the image for the selected target, such as `build/x86_64/redbear-full/harddrive.img`. ### Export External Toolchain @@ -145,22 +145,22 @@ For the full layout and rationale, see `local/docs/EXTERNAL-TOOLCHAIN.md`. ```bash # Preferred Red Bear wrapper: -./local/scripts/build-redbear.sh redbear-minimal +./local/scripts/build-redbear.sh redbear-mini +./local/scripts/build-redbear.sh redbear-live-mini ./local/scripts/build-redbear.sh redbear-full -./local/scripts/build-redbear.sh redbear-kde -./local/scripts/build-redbear.sh redbear-live +./local/scripts/build-redbear.sh redbear-live-full # Direct make is still valid when needed: -make all CONFIG_NAME=redbear-kde +make all CONFIG_NAME=redbear-full ``` -For tracked Red Bear work, prefer the `redbear-*` profiles over older mainline profile names. +For tracked Red Bear work, prefer these four compile targets over older historical names. ### Build a Live ISO ```bash -make live CONFIG_NAME=redbear-live -# Produces: build/x86_64/redbear-live/redox-live.iso +make live CONFIG_NAME=redbear-live-full +# Produces: build/x86_64/redbear-live-full/redox-live.iso ``` ### Rebuild After Changes @@ -174,11 +174,11 @@ make rebuild # Clean rebuild of filesystem image ### QEMU (Recommended) ```bash -# Default tracked KWin Wayland desktop target: +# Default desktop-capable tracked target: make qemu -# Explicit KWin Wayland desktop target: -make qemu CONFIG_NAME=redbear-kde +# Explicit desktop-capable tracked target: +make qemu CONFIG_NAME=redbear-full # With more RAM: make qemu QEMUFLAGS="-m 4G" diff --git a/docs/07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md b/docs/07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md index faaeb5ee..60c445ac 100644 --- a/docs/07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md +++ b/docs/07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md @@ -90,18 +90,19 @@ That means: ## Product Surfaces -The tracked Red Bear profiles are: +The tracked Red Bear compile targets are: -- `redbear-minimal` -- `redbear-desktop` -- `redbear-wayland` +- `redbear-mini` +- `redbear-live-mini` - `redbear-full` -- `redbear-kde` -- `redbear-live` +- `redbear-live-full` -Each profile is a tracked build surface, but only `redbear-kde` is the forward desktop target. +These are the only supported compile targets. Older names such as `redbear-minimal`, +`redbear-desktop`, `redbear-wayland`, `redbear-kde`, and `redbear-live` may still appear in +historical notes or legacy implementation details, but they are not the current compile-target +surface. -### `redbear-minimal` +### `redbear-mini` Primary reproducible baseline. @@ -113,69 +114,42 @@ Scope: - diagnostics, - minimal service baseline. -### `redbear-desktop` - -Supplementary integration profile for shared runtime work beneath the tracked desktop target. - -Scope: - -- runtime services, -- diagnostics, -- shared bring-up support. - -Current role: - -- subordinate integration/support slice. - -### `redbear-wayland` - -Dedicated runtime validation profile. - -Scope: - -- narrow compositor/runtime path, -- explicit validation target for Wayland stack correctness, -- not a claim of full desktop completeness, -- subordinate to the KDE session goal. - ### `redbear-full` -Broader graphics/network/session plumbing profile. +Broader desktop/network/session plumbing profile. Scope: -- desktop/runtime plumbing beyond the narrow Wayland validation slice, +- desktop/runtime plumbing, - D-Bus presence, - Qt base integration, -- broader integration surface before KDE session focus. +- the active desktop-capable target surface. -### `redbear-kde` +### `redbear-live-mini` -Dedicated KWin Wayland target desktop profile. +Live/demo/recovery form of the mini baseline. Scope: -- KWin, -- Plasma session surfaces, -- session packaging and dependencies, -- explicit documentation of limitations while still incomplete, -- the tracked default compositor/session direction. +- diagnostics, +- recovery workflows, +- installability for the non-graphics target. -### Desktop policy +### `redbear-live-full` -- The intended primary desktop direction is KWin Wayland. -- Validation work is subordinate to the KWin Wayland desktop goal. - -### `redbear-live` - -Live/demo/recovery profile. +Live/demo/recovery form of the full desktop target. Scope: - diagnostics, - recovery workflows, - installability, -- demonstrable system identity. +- live desktop-capable system identity. + +### Desktop policy + +- Desktop/graphics are available only on `redbear-full` and `redbear-live-full`. +- Validation work that does not require graphics should prefer `redbear-mini` or `redbear-live-mini`. ## Current State Baseline @@ -401,9 +375,9 @@ Current state: Canonical references: - `local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` — canonical desktop path from console to hardware-accelerated KDE Plasma on Wayland +- `local/docs/WAYLAND-IMPLEMENTATION-PLAN.md` — canonical Wayland subsystem plan beneath the desktop path - `local/docs/QT6-PORT-STATUS.md` - `local/docs/DESKTOP-STACK-CURRENT-STATUS.md` -- `docs/03-WAYLAND-ON-REDOX.md` — historical Wayland implementation rationale - `docs/05-KDE-PLASMA-ON-REDOX.md` — historical KDE implementation rationale Acceptance: @@ -434,6 +408,7 @@ Acceptance: The current subsystem plans to treat as first-class are: - `local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` — canonical desktop path plan +- `local/docs/WAYLAND-IMPLEMENTATION-PLAN.md` — canonical Wayland subsystem plan - `local/docs/IRQ-AND-LOWLEVEL-CONTROLLERS-ENHANCEMENT-PLAN.md` - `local/docs/USB-IMPLEMENTATION-PLAN.md` - `local/docs/WIFI-IMPLEMENTATION-PLAN.md` diff --git a/docs/README.md b/docs/README.md index 2d610ef9..e772b3c6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -40,7 +40,7 @@ current/canonical versus historical/reference split obvious. | `README.md`, `AGENTS.md`, `docs/README.md`, `docs/07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md` | canonical repository-level policy and current execution model | | `local/docs/*IMPLEMENTATION-PLAN*.md`, `local/docs/*STATUS*.md`, `local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md`, `local/docs/DRM-MODERNIZATION-EXECUTION-PLAN.md` | canonical current Red Bear subsystem plans and status | | `docs/01-REDOX-ARCHITECTURE.md` | architecture reference | -| `docs/02-GAP-ANALYSIS.md`, `docs/03-WAYLAND-ON-REDOX.md`, `docs/04-LINUX-DRIVER-COMPAT.md`, `docs/05-KDE-PLASMA-ON-REDOX.md` | valuable but partly historical roadmap/design material | +| `docs/02-GAP-ANALYSIS.md`, `docs/04-LINUX-DRIVER-COMPAT.md`, `docs/05-KDE-PLASMA-ON-REDOX.md` | valuable but partly historical roadmap/design material | When a current-state local document conflicts with an older historical public roadmap, prefer the current local subsystem plan. @@ -51,7 +51,6 @@ current local subsystem plan. |---|----------|-------------| | 01 | [Architecture Overview](01-REDOX-ARCHITECTURE.md) | Architecture reference for Redox internals: microkernel, scheme system, driver model, display stack | | 02 | [Gap Analysis & Roadmap](02-GAP-ANALYSIS.md) | Historical gap matrix plus corrected current phase summary | -| 03 | [Wayland on Redox](03-WAYLAND-ON-REDOX.md) | Historical Wayland implementation path plus deeper Wayland-specific rationale | | 04 | [Linux Driver Compatibility Layer](04-LINUX-DRIVER-COMPAT.md) | Historical/current hybrid design reference for the LinuxKPI-style driver compatibility model | | 05 | [KDE Plasma on Redox](05-KDE-PLASMA-ON-REDOX.md) | Historical KDE implementation path plus deeper KDE-specific rationale | | 06 | [Build System Setup](06-BUILD-SYSTEM-SETUP.md) | How to build Redox from this repository | @@ -72,6 +71,7 @@ current local subsystem plan. - `../local/docs/ACPI-FIXES.md` — historical P0 ACPI bring-up ledger and status record - `../local/docs/IRQ-AND-LOWLEVEL-CONTROLLERS-ENHANCEMENT-PLAN.md` — current low-level controller and IRQ blocker plan - `../local/docs/DRM-MODERNIZATION-EXECUTION-PLAN.md` — current DRM-focused execution plan beneath the canonical desktop path, with equal Intel/AMD evidence bars +- `../local/docs/WAYLAND-IMPLEMENTATION-PLAN.md` — canonical Wayland subsystem plan beneath the desktop path - PCI vendor/device names in Red Bear runtime tools now come from the shipped `pciids` database; PCI quirk policy still lives in `../local/docs/QUIRKS-SYSTEM.md` - `../local/docs/AMD-FIRST-INTEGRATION.md` — AMD-focused technical roadmap and hardware detail only, not the canonical desktop plan - `../local/docs/DESKTOP-STACK-CURRENT-STATUS.md` — canonical current build/runtime truth summary for the desktop stack @@ -96,18 +96,18 @@ This summary is only a quick orientation layer. For canonical current-state deta - `local/docs/PROFILE-MATRIX.md` for support-language by tracked profile, - and the active subsystem plans under `local/docs/` for detailed current workstreams. -- **Desktop target**: the tracked default build now resolves to `CONFIG_NAME?=redbear-kde` +- **Compile targets**: the supported compile targets are `redbear-mini`, `redbear-live-mini`, `redbear-full`, and `redbear-live-full` - **Wayland**: libwayland + wayland-protocols built. Runtime compositor proof remains incomplete. - **Qt6**: qtbase 6.11.0 (Core+Gui+Widgets+DBus+Wayland), qtdeclarative, qtsvg, qtwayland ALL BUILT - **D-Bus**: 1.16.2 built for Redox. Qt6DBus enabled. - **KF6 Frameworks**: all 32/32 built. Some packages remain shimmed or stubbed (kirigami stub-only, kf6-kio heavy shim). - **Mesa**: software-rendered path is present; full GBM / hardware-validated Wayland path is still incomplete. -- **GPU drivers**: redox-drm scheme daemon and AMD+Intel compile-oriented paths exist; hardware validation is still pending. +- **GPU drivers**: redox-drm scheme daemon exists; Intel build-oriented path exists; AMD currently has a bounded retained compile path (`redox-drm` + Red Bear glue) while the imported Linux AMD DC/TTM/core trees remain under compile triage. Hardware validation is still pending. - **Input**: evdevd compiled, libevdev built, libinput 1.30.2 built - **Networking**: native wired stack present (`pcid-spawner` → NIC daemon → `smolnetd`/`dhcpd`/`netcfg`), Red Bear ships a native `netctl` command, RTL8125 is wired into the existing Realtek autoload path, and the bounded Intel Wi‑Fi path now has host-tested profile start/stop plus interface-specific DHCP handoff without claiming real wireless connectivity. - **Wi-Fi profile target**: `config/redbear-wifi-experimental.toml` is the first explicit tracked image slice for bounded Intel Wi‑Fi validation, instead of spreading that claim across the generic desktop profiles. - **Bluetooth**: one bounded in-tree BLE-first experimental slice exists, and the Battery Level read-only workload now has a packaged in-guest checker plus a host QEMU harness; QEMU validation is still in progress, so broad desktop Bluetooth parity is still incomplete -- **KDE direction**: `redbear-kde.toml` is the tracked KWin Wayland desktop direction, and the runtime stack is still incomplete. +- **Desktop direction**: `redbear-full` / `redbear-live-full` carry the desktop-capable target surface, and the runtime stack is still incomplete. - **ACPI**: materially complete for the historical boot baseline, not release-grade complete; implemented: typed startup errors in `acpid`, AML mutex real state, EC widened accesses via byte transactions, kstop-based shutdown eventing; **known gaps**: sleep state transitions and sleep eventing; DMAR remains present in `acpid` but not wired, with ownership still transitional/orphaned rather than cleanly transferred; bare-metal validation remains bounded and still outstanding. See `local/docs/ACPI-IMPROVEMENT-PLAN.md`. - **Linux driver compat**: linux-kpi now includes early wireless-subsystem compatibility scaffolding in addition to the earlier helper layer, redox-driver-sys and firmware-loader compile, and the bounded Intel Wi-Fi path now has host-tested scan/connect/disconnect/profile/reporting flows without claiming real hardware Wi-Fi connectivity. - **Wi-Fi validation tooling**: `redbear-phase5-wifi-check` and `redbear-phase5-wifi-capture` are now packaged in-guest helpers for bounded Intel Wi-Fi runtime validation and evidence capture on bare metal or VFIO-backed guests.