vasilito
a0244075e7
Phase 1 (Critical): - Fix broken config includes: redbear-minimal -> redbear-mini in wifi/bt experimental configs - Fix 05_boot-essential.target dependency: 00_base -> 04_drivers for correct boot ordering - Fix IOMMU service dependency: 00_base -> 05_boot-essential - Fix firmware-loader dependency: 00_base -> 05_boot-essential - Fix messagebus shell: /usr/bin/zsh -> /usr/bin/false (security) - Add offline gate to fetch-firmware.sh (REPO_OFFLINE=1 blocks network access) - Add --upstream gate to fetch-all-sources.sh (network access requires explicit opt-in) - Gate U-Boot wget calls in mk/qemu.mk with REPO_OFFLINE check - Fix patch-inclusion-gate.sh: rewrite from Python deps to pure shell implementation - Fix build-redbear.sh: remove direct patch application, let repo fetch handle it atomically Phase 2 (High): - Increase redbear-full filesystem_size: 4096 -> 8192 MiB for KDE desktop - Deprecate redbear-greeter-services.toml (orphaned, not included by any config) - Add cascade rebuild target to Makefile (make cascade.<package>) - Gate cargo-update.sh with REDBEAR_ALLOW_UPSTREAM - Add deprecation notice to apply-patches.sh - Make protected recipe list data-driven via config/protected-recipes.toml - Replace 127-entry hardcoded Rust matches! with TOML config file reader Phase 3 (Medium): - Fix 5 phantom doc references in local/AGENTS.md (retired/removed docs) - Fix stale config names: redbear-minimal -> redbear-mini across scripts - Fix duplicate references in docs/README.md - Fix run_full.sh and run_mini.sh: hardcoded paths -> relative paths + error handling
157 lines
12 KiB
Markdown
157 lines
12 KiB
Markdown
# Red Bear OS Documentation Index
|
||
|
||
Technical documentation for Red Bear OS as an full fork on top of Redox OS.
|
||
|
||
This index is the entry point for the documentation set. Its main job is to make the
|
||
current/canonical versus historical/reference split obvious.
|
||
|
||
> **Status note (2026-05-01):** The canonical desktop path document is
|
||
> `local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` (v4.0, single comprehensive plan). It supersedes
|
||
> all earlier individual assessments and is the single authority for current state.
|
||
> The historical docs below (01–05) remain useful for architecture reference and implementation
|
||
> rationale, but they should be read together with the new plan and the current local subsystem docs.
|
||
|
||
> `local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` (v4.0) for current state.
|
||
|
||
> **Git hosting policy:** Red Bear OS uses Gitea as its only canonical Git server:
|
||
> `https://gitea.redbearos.org/vasilito/RedBear-OS.git`. Do not use GitHub for Red Bear OS
|
||
> pushes, issues, releases, or project coordination. Historical/upstream references may still point
|
||
> to their original hosts when documenting third-party projects.
|
||
|
||
> **Red Bear note:** newer subsystem plans can also live under `local/docs/` when they are Red Bear-
|
||
> specific rather than general Redox architecture material. In particular, see
|
||
> `local/docs/WIFI-IMPLEMENTATION-PLAN.md` for the current Wi-Fi direction,
|
||
> `local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` for the canonical desktop path.
|
||
|
||
> **Repository model:** RedBearOS relates to Redox in the same way Ubuntu relates to Debian.
|
||
> Upstream Redox remains the base platform; Red Bear carries packaging, patch, validation, and
|
||
> subsystem release fork on top. For long-term stability, upstream-owned source trees should be treated
|
||
> as immutable archived release snapshot, while durable Red Bear state belongs in `local/patches/`,
|
||
> `local/recipes/`, `local/docs/`, and tracked Red Bear configs.
|
||
>
|
||
> **WIP policy:** if an upstream recipe or subsystem is still marked WIP, Red Bear treats it as a
|
||
> local project until upstream promotes it to first-class status. We may immutable archived from upstream WIP,
|
||
> but we should fix and ship from the Red Bear release fork until upstream support is real enough to
|
||
> replace the local copy.
|
||
|
||
## Document Status Matrix
|
||
|
||
| Document set | Role |
|
||
|---|---|
|
||
| `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/CONSOLE-TO-KDE-DESKTOP-PLAN.md` | **canonical comprehensive implementation plan** — supersedes all individual subsystem docs |
|
||
| `local/docs/*IMPLEMENTATION-PLAN*.md`, `local/docs/DRM-MODERNIZATION-EXECUTION-PLAN.md` | subsystem plans for deep-dive detail only; authority chain → console-to-KDE plan |
|
||
| `docs/01-REDOX-ARCHITECTURE.md` | architecture reference |
|
||
| `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
|
||
console-to-KDE plan.
|
||
|
||
## Documents
|
||
|
||
| # | Document | Description |
|
||
|---|----------|-------------|
|
||
| 01 | [Architecture Overview](01-REDOX-ARCHITECTURE.md) | Architecture reference for Redox internals: microkernel, scheme system, driver model, display stack |
|
||
| 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 |
|
||
| 07 | [Red Bear OS Implementation Plan](07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md) | Canonical public implementation plan focused on profiles, packaging, validation, and staged hardware enablement |
|
||
|
||
## Related Red Bear-local current-state plans
|
||
|
||
**Consolidation (2026-04-30)**: 13 standalone assessment docs deleted. All current state is now in
|
||
`local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` (v4.0). Individual subsystem plans remain for detail:
|
||
|
||
- `../local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` — **CANONICAL** comprehensive plan: kernel→DRM→Mesa→Wayland→KDE path
|
||
- `../local/docs/KERNEL-IPC-CREDENTIAL-PLAN.md` — kernel credential syscalls + IPC (implemented)
|
||
- `../local/docs/USB-IMPLEMENTATION-PLAN.md` — USB completeness and rollout
|
||
- `../local/docs/WIFI-IMPLEMENTATION-PLAN.md` — Wi-Fi architecture and rollout
|
||
- `../local/docs/BLUETOOTH-IMPLEMENTATION-PLAN.md` — Bluetooth architecture and rollout
|
||
- `../local/docs/ACPI-IMPROVEMENT-PLAN.md` — ACPI ownership, robustness, validation
|
||
- `../local/docs/IRQ-AND-LOWLEVEL-CONTROLLERS-ENHANCEMENT-PLAN.md` — PCI/IRQ quality, MSI/MSI-X
|
||
- `../local/docs/DRM-MODERNIZATION-EXECUTION-PLAN.md` — DRM-focused execution (subsystem detail)
|
||
- `../local/docs/WAYLAND-IMPLEMENTATION-PLAN.md` — Wayland compositor (subsystem detail)
|
||
- `../local/docs/RELIBC-IPC-ASSESSMENT-AND-IMPROVEMENT-PLAN.md` — relibc IPC surface
|
||
- `../local/docs/GREETER-LOGIN-IMPLEMENTATION-PLAN.md` — greeter/login design
|
||
- `../local/docs/DBUS-INTEGRATION-PLAN.md` — D-Bus architecture
|
||
- `../local/docs/SCRIPT-BEHAVIOR-MATRIX.md` — script guarantees and non-guarantees
|
||
- `../local/docs/QUIRKS-SYSTEM.md` — hardware quirks infrastructure
|
||
|
||
These local Red Bear plans should be treated as first-class subsystem references for desktop/session,
|
||
USB, Wi-Fi, Bluetooth, and low-level controller work. They carry blocker detail that the public docs
|
||
summarize at a higher level.
|
||
|
||
For PCI/IRQ language specifically, prefer the local IRQ plan’s distinction between:
|
||
|
||
- compile-visible infrastructure,
|
||
- bounded QEMU/runtime proof,
|
||
- and broader hardware validation.
|
||
|
||
Do not flatten those into one “supported” claim in public summaries.
|
||
|
||
## Related Red Bear-local governance docs
|
||
|
||
- `../local/docs/SCRIPT-BEHAVIOR-MATRIX.md` — what the main sync/fetch/apply/build scripts do and do not guarantee
|
||
|
||
## Current State Summary (as of 2026-05-01)
|
||
|
||
This summary is only a quick orientation layer. For canonical current-state detail, see `local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` (v4.0).
|
||
|
||
- `docs/07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md` for repository-wide execution order,
|
||
- `local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` for the canonical comprehensive plan,
|
||
- `local/docs/PROFILE-MATRIX.md` for support-language by tracked profile,
|
||
- and the active subsystem plans under `local/docs/` for detailed current workstreams.
|
||
|
||
- **Compile targets**: the supported compile targets are `redbear-mini`, `redbear-full`, and `redbear-grub`
|
||
- **Live ISO policy**: live `.iso` outputs (`make live`) are for real bare-metal boot/install/recovery workflows, not the VM/QEMU execution surface.
|
||
- **Wayland**: libwayland + wayland-protocols built. A bounded greeter/compositor-backed login proof now passes, but broader compositor/runtime stability 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**: 36/48 built, 12 blocked by QML gate. See `local/docs/CONSOLE-TO-KDE-DESKTOP-PLAN.md` for full breakdown.
|
||
- **Mesa**: software-rendered path is present; full GBM / hardware-validated Wayland path is still incomplete.
|
||
- **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 builds and included in redbear-full (2026-04-29). Hardware validation is still pending.
|
||
- **Input**: evdevd compiled, libevdev built, libinput 1.30.2 built
|
||
- **Networking**: native wired stack present (`driver-manager` → NIC daemon → `smolnetd`/`dhcpd`/`netcfg`, with `pcid-spawner` retained only as a compatibility alias), 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.
|
||
- **PCI / IRQ quality**: architecturally strong substrate exists, with bounded MSI-X, IOMMU, xHCI IRQ, and low-level-controller proof surfaces; broader hardware robustness is still intentionally tracked as open work in `../local/docs/IRQ-AND-LOWLEVEL-CONTROLLERS-ENHANCEMENT-PLAN.md`
|
||
- **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
|
||
- **Desktop direction**: `redbear-full` carries the desktop-capable target surface; the bounded greeter/login slice now passes, while the wider desktop runtime stack is still incomplete.
|
||
- **ACPI**: materially complete for the historical boot baseline, not release-grade complete; implemented: AML mutex real state, EC widened accesses via byte transactions, kstop-based shutdown eventing, explicit `RSDP_ADDR` forwarding into `acpid`, x86 BIOS-search AML fallback, and real-but-provisional AML-backed power enumeration. **Known gaps**: the explicit boot-path producer contract for AML bootstrap is still underdocumented, `acpid` startup hardening remains open, shutdown/power reporting are still provisional, sleep state transitions and sleep eventing remain incomplete, DMAR ownership is still transitional, and bare-metal validation is still bounded. 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.
|
||
- **Phase 5 naming note**: the bounded `redbear-phase5-network-check` / `test-phase5-network-qemu.sh` path proves desktop/network plumbing on `redbear-full` in QEMU; it does **not** mean the Wi-Fi implementation plan's later Phase W5 real-hardware reporting/recovery milestone is complete.
|
||
|
||
## Quick Start
|
||
|
||
```bash
|
||
# 1. Install dependencies (Arch/Manjaro)
|
||
sudo pacman -S --needed --noconfirm gdb meson nasm patchelf python-mako \
|
||
doxygen expat file fuse3 gmp libjpeg-turbo libpng po4a scons \
|
||
sdl12-compat syslinux texinfo xdg-utils zstd
|
||
|
||
# 2. Install Rust + tools
|
||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
|
||
source "$HOME/.cargo/env"
|
||
cargo install just cbindgen
|
||
|
||
# 3. Configure for native build (no Podman)
|
||
echo 'PODMAN_BUILD?=0' > .config
|
||
|
||
# 4. Build (downloads cross-toolchain, then compiles)
|
||
make all
|
||
|
||
# 5. Run in QEMU
|
||
make qemu
|
||
```
|
||
|
||
## Key Repositories
|
||
|
||
| Repo | Purpose | URL |
|
||
|------|---------|-----|
|
||
| Kernel | Microkernel | https://gitlab.redox-os.org/redox-os/kernel |
|
||
| Base | Drivers + system components | https://gitlab.redox-os.org/redox-os/base |
|
||
| relibc | C library (Rust) | https://gitlab.redox-os.org/redox-os/relibc |
|
||
| RedoxFS | Default filesystem | https://gitlab.redox-os.org/redox-os/redoxfs |
|
||
| libredox | System library | https://gitlab.redox-os.org/redox-os/libredox |
|
||
| This repo | Build system | https://gitlab.redox-os.org/redox-os/redox |
|