EriX Documentation Repository

This repository contains the normative documentation and policies governing the EriX operating system project.

EriX is a clean-room, capability-based microkernel OS written entirely in Rust.

This repository defines:

• Architectural principles
• Clean-room policies
• Dependency policies
• Contribution requirements
• Security expectations
• Governance constraints
• Normative interface specifications (boot image, handoffs, IPC syscall ABI)

It does NOT contain implementation code.

---

Authoritative Scope

Policies in this repository are binding for:

• All EriX repositories
• All contributors
• All pull requests
• All CI checks

Violations may result in contribution rejection.

---

Clean-Room Core Rule

EriX is a clean-room system.

This means:

• No external source code.
• No external Rust crates.
• No vendoring.
• No linking to third-party libraries.
• No snippet copying.

Implementation must be original and authored within the project.

See:

• policies/no-external-code.md
• policies/dependencies.md

---

Integration Contracts

Current integration marker and exit-code conventions used by bootloader and integration CI:

• marker families:
  • ERIX_BOOTLOADER:*
  • ERIX_KERNEL:* and ERIX_KERNEL_STUB:*
  • ERIX_KRN:*
• exit classes:
  • 0x10 success
  • 0x11 bootloader failure
  • 0x12 kernel failure
  • 0x13 root failure
  • 0x14 service bootstrap failure

Long-Term Objective

EriX SHALL:

Build EriX inside EriX, producing a signed boot image.

All documentation and policies exist to support this goal.

---

Normative Interface Specs

• bootimg/format-v1.md: canonical boot.img wire format
• handoff/bl-to-kernel.md: bootloader to kernel handoff contract
• handoff/kernel-to-root.md: kernel to root bootstrap authority contract
• handoff/root-to-services.md: root to critical services startup contract
• ipc/syscall-v1.md: IPC syscall transport ABI v1 (frozen February 28, 2026)

---

Legal

All documentation is ISC licensed unless otherwise specified.