.gitignore

@@ -2,3 +2,11 @@
 /prefix/
 .config
 **/my_*
+# Local settings folder for Jetbrains products (RustRover, IntelliJ, CLion)
+.idea/
+# Local settings folder for Visual Studio Professional
+.vs/
+# Local settings folder for vscode
+.vscode/
+# Local settings folder for the devcontainer extension that most IDEs support.
+.devcontainer/

.gitlab-ci.yml

+# The GitLab Continuous Integration configuration
 image: "ubuntu:22.04"
 
 variables:
@@ -14,32 +15,30 @@ before_script:
         bison \
         build-essential \
         curl \
-        dosfstools \
         flex \
-        fuse \
-        genisoimage \
+        fuse3 \
         git \
-        gnupg \
         libfuse-dev \
         nasm \
-        parted \
         pkg-config \
-        software-properties-common \
-        syslinux \
-        syslinux-utils \
         texinfo \
-        wget &&
+        wget \
+        help2man \
+        autoconf \
+        automake \
+        zstd &&
     curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain none
 
 img:
     script:
      - |
         source "$HOME/.cargo/env" &&
-        cargo install --version 0.1.1 cargo-config &&
-        cargo install --version 1.16.0 just &&
-        cargo install --version 0.26.0 cbindgen &&
+        curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash &&
+        cargo binstall --no-confirm --version 0.1.1 cargo-config &&
+        cargo binstall --no-confirm --version 1.16.0 just &&
+        cargo binstall --no-confirm --version 0.27.0 cbindgen &&
         cargo build --manifest-path installer/Cargo.toml --release &&
-        make ci-img IMG_TAG=$CI_COMMIT_REF_NAME REPO_BINARY=1
+        PODMAN_BUILD=0 REPO_BINARY=1 make ci-img IMG_TAG=$CI_COMMIT_REF_NAME
     artifacts:
         paths:
          - build/img/

.gitmodules

@@ -9,7 +9,7 @@
 [submodule "rust"]
 	path = rust
 	url = https://gitlab.redox-os.org/redox-os/rust.git
-	branch = redox-2023-09-07
+	branch = redox-2025-01-12
 	update = none
 [submodule "redoxfs"]
 	path = redoxfs

CONTRIBUTING.md

@@ -4,6 +4,8 @@
 
 This document will outline the basics of where to start if you wish to contribute to the project. There are many ways to help us out and and we appreciate all of them. We look forward to **your contribution!**
 
+**Please read this document until the end**
+
 ## Code Of Conduct
 
 We follow the [Rust Code Of Conduct](https://www.rust-lang.org/policies/code-of-conduct).
@@ -12,93 +14,147 @@ We follow the [Rust Code Of Conduct](https://www.rust-lang.org/policies/code-of-
 
 In general, your contributions to Redox are governed by the [MIT License](https://en.wikipedia.org/wiki/MIT_License). Each project repository has a `LICENSE` file that provides the license terms for that project.
 
-Please review the LICENSE for the project you are contributing to.
+Please review the `LICENSE` file for the project you are contributing to.
 
-On [this](https://doc.redox-os.org/book/ch01-02-philosophy.html) page we explain why we use the MIT license.
+[This](https://doc.redox-os.org/book/philosophy.html) page we explain why we use the MIT license.
 
 ## Chat
 
-Join us on [Matrix Chat](https://doc.redox-os.org/book/ch13-01-chat.html) to discuss issues or ask questions.
-
-## Suggestions for Contributions
+Join us on [Matrix Chat](https://doc.redox-os.org/book/chat.html) to discuss issues or ask questions.
 
-(Before starting to contribute you **must** read the [FAQ](https://www.redox-os.org/faq/) and the [Redox Book](https://doc.redox-os.org/book/))
+## Important Places to Contribute
 
-You can contribute to the Redox documentation and code on these repositories:
+Before starting to contribute, we recommend reading the [Website FAQ](https://www.redox-os.org/faq/) and the [Redox Book](https://doc.redox-os.org/book/).
 
-(The order is based on difficulty, easy things first)
+You can contribute to the Redox documentation and code on the following repositories (non-exhaustive, easiest first):
 
 - [Website](https://gitlab.redox-os.org/redox-os/website)
-- [Book](https://gitlab.redox-os.org/redox-os/book)
+- [Book](https://gitlab.redox-os.org/redox-os/book) - High-level documentation
 - [Build System Configuration](https://gitlab.redox-os.org/redox-os/redox) - Our main repository
-- [Cookbook](https://gitlab.redox-os.org/redox-os/cookbook) - Package system
+- [Cookbook](https://gitlab.redox-os.org/redox-os/cookbook) - Software Ports System
+- [Orbital](https://gitlab.redox-os.org/redox-os/orbital) - Display Server and Window Manager
+- [pkgutils](https://gitlab.redox-os.org/redox-os/pkgutils) - Package Manager
+- [resist](https://gitlab.redox-os.org/redox-os/resist) - Redox System Interface Specifications and Tests (also has POSIX tests)
+- [acid](https://gitlab.redox-os.org/redox-os/acid) - Redox Test Suite
 - [relibc](https://gitlab.redox-os.org/redox-os/relibc) - Redox C Library
-- [Drivers](https://gitlab.redox-os.org/redox-os/drivers)
+- [libredox](https://gitlab.redox-os.org/redox-os/libredox) - Redox System Library
+- [netstack](https://gitlab.redox-os.org/redox-os/netstack) - Network Stack
+- [Bootloader](https://gitlab.redox-os.org/redox-os/bootloader)
+- [Drivers](https://gitlab.redox-os.org/redox-os/drivers) - Device Drivers
 - [Kernel](https://gitlab.redox-os.org/redox-os/kernel)
 
-### Places to Contribute
+To see all Redox repositories open the [redox-os group](https://gitlab.redox-os.org/redox-os).
+
+### Skill Levels
 
-If you aren't fluent in Rust:
+If you don't know programming:
 
 - Write documentation
-- Use and test Redox, fill issues for bugs or needed features (verify the repository issues before)
-- Web development on the [website](https://gitlab.redox-os.org/redox-os/website)
+- Use and test Redox, and file issues for bugs or needed features (please check for duplicates first etc.)
+
+If you don't know how to code in Rust, but know other programming languages:
+
+- Web development on the website (we don't accept JavaScript code)
 - Write unit tests (may require minimal knowledge of Rust)
+- Port C/C++ programs to Redox (read the `TODO`s of the recipes on the [WIP category](https://gitlab.redox-os.org/redox-os/cookbook/-/tree/master/recipes/wip?ref_type=heads))
+- Port programs to Redox
 
-If you are fluent in Rust, but not operating system Development:
+If you know how to code in Rust, but don't know operating system development:
 
-- Port programs written in Rust to Redox (in most cases you need to port crates, be aware of missing functions on relibc, porting without these functions will make patches dirty)
-- [relibc](https://gitlab.redox-os.org/redox-os/relibc) - Redox C Library
-- The [Ion Shell](https://gitlab.redox-os.org/redox-os/ion)
-- [Package Manager](https://gitlab.redox-os.org/redox-os/pkgutils)
+- Look for issues labeled "good first issue", "easy", and/or "help wanted", e.g. [this GitLab filter](https://gitlab.redox-os.org/groups/redox-os/-/issues/?sort=updated_desc&state=opened&or%5Blabel_name%5D%5B%5D=good%20first%20issue&or%5Blabel_name%5D%5B%5D=Easy&or%5Blabel_name%5D%5B%5D=easy&or%5Blabel_name%5D%5B%5D=help%20wanted&first_page_size=20]). Worth noting the skill level varies between projects, but a large subset of these should be approachable by contributors familiar with regular Rust/Unix application programming.
+- Improve the package manager, or other meta-tools like `redoxer` or `installer`
+- Improve the [Ion](https://gitlab.redox-os.org/redox-os/ion) shell, or other high-level or mid-level projects
+- Port Rust programs to Redox, possibly including dependencies, and C library extensions if necessary (also look for issues with the `port` label)
+- Improve program compatibility in relibc by e.g. implementing missing APIs
 
-If you are fluent in Rust, and have experience with operating system development:
+If you know how to code in Rust, and have experience with systems software/OS development:
 
-- Familiarize yourself with the repository and codebase
-- Grep for `TODO`, `FIXME`, `BUG`, `UNOPTIMIZED`, `REWRITEME`, `DOCME`, and `PRETTYFYME` and fix the code you find
-- Update older code to remove warnings
-- Improve and optimize code, especially in the kernel
-- Write drivers
+- Familiarize yourself with the repository layout, code, and build system
+- Update old code to remove warnings
+- Search for `TODO`, `FIXME`, `BUG`, `UNOPTIMIZED`, `REWRITEME`, `DOCME`, and `PRETTYFYME` and fix the code you find
+- Look in general for issues with the following labels: `critical`, `help wanted`, `feature`, `enhancement`, `bug` or `port`
+- Improve internal libraries and abstractions, e.g. `libredox`, `redox-scheme`, `redox-event` etc.
+- Help upstream Redox-specific functionality to the Rust ecosystem
+- Improve Redox's automated testing suite and continuous integration testing processes
+- Improve, profile, and optimize code, especially in the kernel, filesystem, and network stack
+- Improve or write device drivers
 
 For those who want to contribute to the Redox GUI, our GUI strategy has recently changed.
 
-- We are porting the [COSMIC compositor](https://github.com/pop-os/cosmic-comp), help wanted.
-- Redox is in the process of adopting other Rust-lang GUIs such as [Iced](https://iced.rs) and [Slint](https://slint-ui.com/). Please check out those projects if this is your area of interest.
+- We are improving the [Orbital](https://gitlab.redox-os.org/redox-os/orbital) display server and window manager, you can read more about it on [this tracking issue](https://gitlab.redox-os.org/redox-os/redox/-/issues/1430).
+- Redox is in the process of adopting other Rust-written GUI toolkits, such as [Iced](https://iced.rs) and [Slint](https://slint-ui.com/). Please check out those projects if this is your area of interest.
 - OrbTk is in maintenance mode, and its developers have moved to other projects such as the ones below. There is currently no Redox-specific GUI development underway.
 
-## Tracking Issues Index
+## Priorities
 
-We use the Tracking Issues Index to ease the development workflow, you can find them on [this](https://gitlab.redox-os.org/redox-os/redox/-/issues/1384) page.
+You can use the following GitLab label filters to know our development priorities on the moment:
+
+- [Critical](https://gitlab.redox-os.org/redox-os/redox/-/issues/?sort=created_date&state=opened&label_name%5B%5D=critical&first_page_size=20)
+- [High-priority](https://gitlab.redox-os.org/redox-os/redox/-/issues/?sort=created_date&state=opened&label_name%5B%5D=high-priority&first_page_size=20)
+- [Medium-priority](https://gitlab.redox-os.org/redox-os/redox/-/issues/?sort=created_date&state=opened&label_name%5B%5D=medium-priority&first_page_size=20)
+- [Low-priority](https://gitlab.redox-os.org/redox-os/redox/-/issues/?sort=created_date&state=opened&label_name%5B%5D=low-priority&first_page_size=20)
+
+## RFCs
+
+For more significant changes that affect Redox's architecture, we use the [Request for Comments](https://gitlab.redox-os.org/redox-os/rfcs) repository.
 
 ## Build System
 
-You can find the Redox build system organization and commands on [this](https://doc.redox-os.org/book/ch08-06-build-system-reference.html) page.
+To download the build system use the following commands:
+
+(You need to have [curl](https://curl.se/) installed on your system)
+
+```sh
+curl -sf https://gitlab.redox-os.org/redox-os/redox/raw/master/podman_bootstrap.sh -o podman_bootstrap.sh
+```
+
+```sh
+time bash -e podman_bootstrap.sh
+```
+
+To start the compilation of the default recipes run the command below:
+
+```sh
+make all
+```
+
+In case your operating system does not use SELinux, you must set the `USE_SELINUX` to `0` when calling `make all`, otherwise you might experience errors:
+
+```sh
+make all USE_SELINUX=0
+```
+
+You can find the build system organization and commands on the [Build System](https://doc.redox-os.org/book/build-system-reference.html) page.
 
 ## Developer FAQ
 
-You can see the most common questions and problems on [this](https://doc.redox-os.org/book/ch09-07-developer-faq.html) page.
+You can see the most common questions and problems on the [Developer FAQ](https://doc.redox-os.org/book/developer-faq.html) page.
 
 ## Porting Software
 
-You can read how to use the Cookbook recipe system to port applications on [this](https://doc.redox-os.org/book/ch09-03-porting-applications.html) page.
+You can read how to use the Cookbook recipe system to port applications on the [Porting Applications using Recipes](https://doc.redox-os.org/book/porting-applications.html) page.
 
 ## Libraries and APIs
 
-You can read [this](https://doc.redox-os.org/book/ch09-06-libraries-apis.html) page to learn about the libraries and APIs used in Redox.
+You can read the [Libraries and APIs](https://doc.redox-os.org/book/libraries-apis.html) page to learn about the libraries and APIs used in Redox.
+
+## Visual Studio Code (VS Code) Configuration
+
+To learn how to configure your VS Code to do Redox development please read the information below the [Visual Studio Code Configuration](https://doc.redox-os.org/book/coding-and-building.html#visual-studio-code-configuration) section.
 
 ## Development Tips
 
-You can find important tips on [this](https://doc.redox-os.org/book/ch09-02-coding-and-building.html#development-tips) section.
+You can find important tips on the [Development Tips](https://doc.redox-os.org/book/coding-and-building.html#development-tips) section.
 
 ## References
 
-We maintain a list of wikis, articles and videos to learn Rust, OS development and computer science on [this](https://doc.redox-os.org/book/ch09-08-references.html) page.
+We maintain a list of wikis, articles and videos to learn Rust, OS development and computer science on the [References](https://doc.redox-os.org/book/references.html) page.
 
 If you are skilled there's a possibility that they could improve your knowledge in some way.
 
 ## Best Practices and Guidelines
 
-You can read the best practices and guidelines on [this](https://doc.redox-os.org/book/ch11-00-best-practices.html) chapter.
+You can read the best practices and guidelines on the [Best practices and guidelines](https://doc.redox-os.org/book/best-practices.html) chapter.
 
 ## Style Guidelines
 
@@ -108,17 +164,25 @@ Since **Rust** is a relatively small and new language compared to others like C
 
 ### Git
 
-Please follow our [Git style](https://doc.redox-os.org/book/ch12-04-creating-proper-pull-requests.html) for pull requests.
+Please follow our [Git style](https://doc.redox-os.org/book/creating-proper-pull-requests.html) for pull requests.
 
 ## GitLab
 
+### Identity
+
+Once your GitLab account is created, you should add your Matrix or Discord username (the name after the `@` symbol) on the "About" section of your profile, that way we recognize you properly.
+
 ### Issues
 
-To know how to create issues on the Redox GitLab, read [this](https://doc.redox-os.org/book/ch12-05-filing-issues.html) page.
+To know how to create issues on the Redox GitLab, read the [Filing Issues](https://doc.redox-os.org/book/filing-issues.html) page.
+
+Once you create an issue don't forget to post the link on the Dev or Support rooms of the chat, because the GitLab email notifications have distractions (service messages or spam) and most developers don't left their GitLab pages open to receive desktop notifications from the web browser (which require a custom setting to receive issue notifications).
+
+By doing this you help us to pay attention to your issues and avoid them to be accidentally forgotten.
 
 ### Pull Requests
 
-Please follow [our process](https://doc.redox-os.org/book/ch12-04-creating-proper-pull-requests.html) for creating proper pull requests.
+Please follow [our process](https://doc.redox-os.org/book/creating-proper-pull-requests.html) for creating proper pull requests.
 
 ## Other Ways to Contribute
 
@@ -131,8 +195,8 @@ If you're a good designer, whether it's 2D graphics, 3D graphics, interfaces, we
 - [Redox backgrounds](https://gitlab.redox-os.org/redox-os/backgrounds) - You can send your wallpapers on this repository.
 - [Redox assets](https://gitlab.redox-os.org/redox-os/assets) - You can send your logos, icons and themes on this repository.
 
-If you have questions about the graphic design, ask us on the [Chat](https://doc.redox-os.org/book/ch13-01-chat.html).
+If you have questions about the graphic design, ask us on the [Chat](https://doc.redox-os.org/book/chat.html).
 
 ### Donate to Redox
 
-If you are interested in donating to the Redox OS Nonprofit, you can find instructions [here](https://www.redox-os.org/donate/).
+If you are interested in donating to the Redox OS Nonprofit, you can find instructions on the [Donate](https://www.redox-os.org/donate/) page.

HARDWARE.md

@@ -2,26 +2,28 @@
 
 This document tracks the current hardware compatibility of Redox.
 
+- [Why hardware reports are needed?](#why-hardware-reports-are-needed)
+- [What if my computer is customized?](#what-if-my-computer-is-customized)
 - [Status](#status)
 - [General](#general)
 - [Template](#template)
-- [x86-64](#x86-64)
-    - [System76](#system76)
-    - [Dell](#dell)
-    - [HP](#hp)
-    - [ASUS](#asus)
-    - [Lenovo](#lenovo)
-    - [Toshiba](#toshiba)
-    - [Custom](#custom)
-- [i686](#i686)
-    - [Dell](#dell-1)
-    - [ASUS](#asus-1)
-    - [Lenovo](#lenovo-1)
-    - [Toshiba](#toshiba-1)
-    - [Panasonic](#panasonic)
-    - [Custom](#custom-1)
-- [ARM64](#arm64)
-    - [Custom](#custom-2)
+- [Recommended](#recommended)
+- [Booting](#booting)
+- [Broken](#broken)
+
+## Why hardware reports are needed?
+
+Each computer model have different hardware interface/firmware implementations and devices, which can cause the following problems:
+
+- Boot bugs
+- Lack of device support
+- Performance degradation
+
+These reports helps us to fix the problems above.
+
+## What if my computer is customized?
+
+You can use the "Custom" word on the "Vendor" and "Model" categories, we also recommend to add your `pciutils` log on [this document link](https://gitlab.redox-os.org/redox-os/drivers/-/blob/master/COMMUNITY-HW.md?ref_type=heads) to help us with probable porting.
 
 ## Status
 
@@ -34,294 +36,57 @@ This document tracks the current hardware compatibility of Redox.
 This section cover things to consider.
 
 - ACPI support is incomplete (some things are hardcoded on the kernel)
-- USB support is incomplete (desktops are generally not recommended)
+- Only USB input devices are supported
 - Wi-Fi is not supported
-- GPU drivers aren't supported (only VESA and GOP)
+- GPU drivers aren't supported (only VESA and UEFI GOP)
 - Automatic operating system discovery on boot loader is not implemented (remember this before installing Redox)
 
 ## Template
 
-You will use this template to insert your computer.
-
-- **Computer model**
-
-```
-Status - (Broken, Booting or Recommended)
-Redox version - 0.0.0
-Variant - (server-minimal, desktop-minimal, server, desktop, demo, dev or customized)
-Image date - day-month-year
-
-- Additional details goes here as items
-```
-
-## x86-64
-
-Computers using a 64 bits Intel/AMD CPU.
-
-### System76
-
-- **System76 Galago Pro (galp5)**
-
-```
-Status - Recommended
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using UEFI
-- Boots to desktop
-```
-
-- **System76 Lemur Pro (lemp9)**
-
-```
-Status - Recommended
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using UEFI
-- Boots to desktop
-```
-
-- **System76 Oryx Pro (oryp10)**
-
-```
-Status - Booting
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using UEFI
-- Boots to desktop
-- No touchpad support, though it should be working
-```
-
-- **System76 Pangolin (pang12)**
-
-```
-Status - Booting
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using UEFI
-- Boots to desktop
-- No touchpad support, requires I2C HID
-```
-
-### Dell
-
-- **Dell XPS 13 (9350)**
-
-```
-Status - Booting
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using both BIOS and UEFI
-- Boots to desktop
-- NVMe driver livelocks
-```
-
-### HP
-
-- **HP Dev One**
-
-```
-Status - Booting
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using UEFI
-- Boots to desktop
-- No touchpad support, requires I2C HID
-```
-
-### ASUS
-
-- **ASUS X554L**
-
-```
-Status - Booting
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using BIOS
-- Boots to desktop
-- No audio, HDA driver cannot find output pins
-```
-
-- **ASUS ROG g55vw**
-
-```
-Satus - Booting
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2023
-
-- Booted using BIOS
-- Boots to desktop
-- UEFI panic in SETUP
-```
-
-### Lenovo
-
-- **Lenovo IdeaPad Y510P**
-
-```
-Status - Recommended
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using both BIOS and UEFI
-- Boots to desktop
-```
-
-- **Lenovo G570**
-
-```
-Status - Broken
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using BIOS
-- Correct video mode not offered, this is a firmware issue
-- Bootloader panics in alloc_zeroed_page_aligned
-```
-
-### Toshiba
-
-- **Toshiba Satellite L500**
-
-```
-Status - Booting
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using BIOS
-- Correct video mode not offered, this is a firmware issue
-- Boots to desktop
-- No ethernet driver
-```
-
-### Custom
-
-If you have a customized computer, put it here.
-
-
-
-## i686
-
-Computers with a 32 bits Intel/AMD CPU.
-
-### Dell
-
-- **Dell XPS 13 (9350)**
-
-```
-Status - Booting
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using BIOS
-- Boots to desktop
-- NVMe driver livelocks
-```
-
-### ASUS
-
-- **ASUS Eee PC 900**
-
-```
-Status - Booting
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using BIOS
-- Correct video mode not offered, this is a firmware issue
-- Boots to desktop
-- No ethernet driver
-```
-
-### Lenovo
-
-- **Lenovo IdeaPad Y510P**
-
-```
-Status - Broken
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using BIOS
-- Panics on phys_to_virt overflow, probably having invalid mappings for 32-bit
-```
-
-### Toshiba
-
-- **Toshiba Satellite L500**
-
-```
-Status - Broken
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using BIOS
-- Correct video mode not offered, this is a firmware issue
-- Panics on phys_to_virt overflow, probably having invalid mappings for 32-bit
-```
-
-### Panasonic
-
-- **Panasonic Toughbook CF-18**
-
-```
-Status - Broken
-Redox version - 0.8.0
-Variant - desktop
-Image date - 11-11-2022
-
-- Booted using BIOS
-- Hangs after PIT initialization
-```
-
-### Custom
-
-If you have a customized computer, put it here.
-
-
-
-## ARM64
-
-Computers using a 64 bits ARM CPU.
-
-### Raspberry Pi
-
-- **Raspberry Pi 3 Model B+**
-
-```
-Status - Booting
-Redox version - 0.8.0
-Variant - server
-Image date - None
-
-- Booted using Uboot
-- Boots to UART serial console
-- a bcm2835-sdhci/mmc driver
-- pl011 UART
-```
-
-### Custom
-
-If you have a customized ARM board, put it here.
+You will use this template to insert your computer on the table.
+
+```
+|  |  |  |  |  |  |  |  |
+```
+
+## Recommended
+
+| **Vendor** | **Model** | **Redox Version** | **Image Date** | **Variant** | **CPU Architecture** | **Motherboard Firmware** | **Report** |
+|------------|-----------|-------------------|----------------|-------------|----------------------|--------------------------|------------|
+| System76 | Galago Pro (galp5) | 0.8.0 | 11-11-2022 | desktop | x86-64 | UEFI | Boots to Orbital |
+| System76 | Lemur Pro (lemp9) | 0.8.0 | 11-11-2022 | desktop | x86-64 | UEFI | Boots to Orbital |
+| Lenovo | IdeaPad Y510P | 0.8.0 | 11-11-2022 | desktop | x86-64 | BIOS, UEFI | Boots to Orbital |
+
+## Booting
+
+| **Vendor** | **Model** | **Redox Version** | **Image Date** | **Variant** | **CPU Architecture** | **Motherboard Firmware** | **Report** |
+|------------|-----------|-------------------|----------------|-------------|----------------------|--------------------------|------------|
+| System76 | Oryx Pro (oryp10) | 0.8.0 | 11-11-2022 | desktop | x86-64 | UEFI | Boots to Orbital, No touchpad support, though it should be working |
+| System76 | Pangolin (pang12) | 0.8.0 | 11-11-2022 | desktop | x86-64 | UEFI | Boots to Orbital, No touchpad support, requires I2C HID |
+| Dell | XPS 13 (9350) | 0.8.0 | 11-11-2022 | desktop | x86-64 | BIOS, UEFI | Boots to Orbital, NVMe driver livelocks |
+| Dell | XPS 13 (9350) | 0.8.0 | 11-11-2022 | desktop | i686 | BIOS | Boots to Orbital, NVMe driver livelocks |
+| HP | Dev One | 0.8.0 | 11-11-2022 | desktop | x86-64 | UEFI | Boots to Orbital, No touchpad support, requires I2C HID |
+| ASUS | X554L | 0.8.0 | 11-11-2022 | desktop | x86-64 | BIOS | Boots to Orbital, No audio, HDA driver cannot find output pins |
+| ASUS | ROG g55vw | 0.8.0 | 11-11-2023 | desktop | x86-64 | BIOS | Boots to Orbital, UEFI panic in SETUP |
+| ASUS | PRIME B350M-E (custom) | 0.9.0 | 20-09-2024 | desktop | x86-64 | UEFI | Partial support for the PS/2 keyboard, PS/2 mouse is broken |
+| ASUS | Eee PC 900 | 0.8.0 | 11-11-2022 | desktop | i686 | BIOS | Boots to Orbital, No ethernet driver, Correct video mode not offered (firmware issue) |
+| Toshiba | Satellite L500 | 0.8.0 | 11-11-2022 | desktop | x86-64 | BIOS | Boots to Orbital, No ethernet driver, Correct video mode not offered (firmware issue) |
+| Raspberry Pi | 3 Model B+ | 0.8.0 | Unknown | server | ARM64 | U-Boot | Boots to UART serial console (pl011) |
+| Lenovo | ThinkPad Yoga 260 Laptop - Type 20FE | 0.9.0 | 07-09-2024 | demo | x86-64 | UEFI | Boots to Orbital, No audio |
+| Lenovo | Yoga S730-13IWL | 0.9.0 | 09-11-2024 | desktop | x86-64 | UEFI | Boots to Orbital, No trackpad or USB mouse input support |
+
+## Broken
+
+| **Vendor** | **Model** | **Redox Version** | **Image Date** | **Variant** | **CPU Architecture** | **Motherboard Firmware** | **Report** |
+|------------|-----------|-------------------|----------------|-------------|----------------------|--------------------------|------------|
+| HP | EliteBook 2570p | 0.8.0 | 23-11-2022 | demo | x86-64 | BIOS (CSM mode?) | Gets to resolution selection, Fails assert in `src/os/bios/mod.rs:77` after selecting resolution |
+| BEELINK | U59 | 0.8.0 | 30-05-2024 | server | x86-64 | Unknown | Aborts after panic in xhcid |
+| ASUS | PN41 | 0.8.0 | 30-05-2024 | server | x86-64 | Unknown | Aborts after panic in xhcid |
+| Lenovo | G570 | 0.8.0 | 11-11-2022 | desktop | x86-64 | BIOS | Bootloader panics in `alloc_zeroed_page_aligned`, Correct video mode not offered (firmware issue) |
+| Lenovo | IdeaPad Y510P | 0.8.0 | 11-11-2022 | desktop | i686 | BIOS | Panics on `phys_to_virt overflow`, probably having invalid mappings for 32-bit |
+| Framework | Laptop 16 (AMD Ryzen 7040 Series) | 0.9.0 | 07-09-2024 | server, demo | x86-64 | UEFI | Black screen and unresponsive after the bootloader and resolution selection |
+| Toshiba | Satellite L500 | 0.8.0 | 11-11-2022 | desktop | i686 | BIOS | Correct video mode not offered (firmware issue), Panics on `phys_to_virt overflow`, probably having invalid mappings for 32-bit |
+| Panasonic | Toughbook CF-18 | 0.8.0 | 11-11-2022 | desktop | i686 | BIOS | Hangs after PIT initialization |
+| XMG (Schenker) | Apex 17 (M21) | 0.9.0 | 30-09-2024 | demo, server | x86-64 | UEFI | After selecting resolution, (release) repeats `...::interrupt::irq::ERROR -- Local apic internal error: ESR=0x40` a few times before it freezes; (daily) really slowly prints statements from `...::rmm::INFO` before it abruptly aborts |
+| HP | Compaq nc6120 | 0.9.0 | 2024-11-08 | desktop, server | i686 | BIOS | Unloads into memory at a rate slower than 1MB/s after selecting resolution. When unloading is complete the logger initializes and crashes after kernel::acpi, some information about APIC is printed. Boot logs do not progress after this point. |
 

Makefile

-# Configuration and variables
+# This file contains the build system commands configuration
+# and environment variables
 include mk/config.mk
 
-# Dependencies
+# Build system dependencies
 include mk/depends.mk
 
 all: $(BUILD)/harddrive.img
@@ -24,7 +25,7 @@ image:
 rebuild:
 	-$(FUMOUNT) $(BUILD)/filesystem/ || true
 	-$(FUMOUNT) /tmp/redox_installer/ || true
-	rm -rf $(BUILD)
+	rm -rf $(BUILD)/repo.tag $(BUILD)/harddrive.img $(BUILD)/livedisk.iso
 	$(MAKE) all
 
 clean: $(CONTAINER_TAG)
@@ -33,7 +34,6 @@ ifeq ($(PODMAN_BUILD),1)
 else
 	cd cookbook && ./clean.sh
 	-rm -rf cookbook/repo
-	cargo clean --manifest-path cookbook/pkgutils/Cargo.toml
 	cargo clean --manifest-path installer/Cargo.toml
 	cargo clean --manifest-path redoxfs/Cargo.toml
 	cargo clean --manifest-path relibc/Cargo.toml
@@ -89,8 +89,20 @@ else
 	bash
 endif
 
+export RUST_GDB=gdb-multiarch # Necessary when debugging for another architecture than the host
+GDB_KERNEL_FILE=cookbook/recipes/core/kernel/target/$(TARGET)/build/kernel.sym
 gdb: FORCE
-	gdb cookbook/recipes/core/kernel/target/$(TARGET)/build/kernel.sym --eval-command="target remote localhost:1234"
+	rust-gdb $(GDB_KERNEL_FILE) --eval-command="target remote :1234"
+
+# This target allows debugging a userspace application without requiring gdbserver running inside
+# the VM. Because gdb doesn't know when the userspace application is scheduled by the kernel and as
+# it stops the entire VM rather than just the userspace application that the user wants to debug,
+# connecting to a gdbserver running inside the VM is highly encouraged when possible. This target
+# should only be used when the application to debug runs early during boot before the network stack
+# has started or you need to debug the interaction between the application and the kernel.
+# tl;dr: DO NOT USE THIS TARGET UNLESS YOU HAVE TO
+gdb-userspace: FORCE
+	rust-gdb $(GDB_APP_FILE) --eval-command="add-symbol-file $(GDB_KERNEL_FILE) 0x$(shell readelf -S $(GDB_KERNEL_FILE) | grep .text | cut -c43-58)" --eval-command="target remote :1234"
 
 # An empty target
 FORCE:

README.md

@@ -2,72 +2,62 @@
 <img alt="Redox" width="346" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/logos/redox/logo.png">
 </p>
 
-[Redox](https://www.redox-os.org) is an operating system written in Rust, a language with focus on safety, efficiency and high performance. Redox, following the microkernel design, aims to be reliable, secure, usable, correct and free. Redox is inspired by previous operating systems, such as seL4, MINIX, Plan 9, Linux and BSD.
+This repository is the **Build System** for Redox OS.
 
-Redox _is not_ just a kernel, it's a **full-featured operating system**, providing components (memory allocator, file system, display manager, core utilities, etc.) that together make up a functional and convenient operating system. You can loosely think of it as the GNU or BSD ecosystem, but in a memory safe language and with modern technology.
+Redox is under active development by a vibrant community, you can see the key links below:
 
-[![Downloads](https://img.shields.io/github/downloads/redox-os/redox/total.svg)](https://gitlab.redox-os.org/redox-os/redox/tags)
-[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+- [The **main website** for Redox OS](https://www.redox-os.org).
+- [The Redox Book](https://doc.redox-os.org/book/) and [Build Instructions](https://doc.redox-os.org/book/podman-build.html).
+- [Redox Chat and Support](https://matrix.to/#/#redox-join:matrix.org).
+- [Patreon](https://www.patreon.com/redox_os), [Donate](https://redox-os.org/donate/) and [Merch](https://redox-os.creator-spring.com/).
+- Scroll down for a list of key Redox components and their repositories.
+
+[Redox](https://www.redox-os.org) is an open-source operating system written in Rust, a language with focus on safety, efficiency and high performance. Redox uses a microkernel architecture, and aims to be reliable, secure, usable, correct, and free. Redox is inspired by previous operating systems, such as seL4, MINIX, Plan 9, Linux and BSD.
 
-## Guide
+Redox _is not_ just a kernel, it's a **full-featured operating system**, providing components (file system, display server, core utilities, etc.) that together make up a functional and convenient operating system. Redox uses the COSMIC desktop apps, and provides source code compatibility with many Rust, Linux and BSD programs.
 
-This is the main repository of the Redox GitLab where the build system files are stored, this README is used to guide new developers.
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
 
-You can find the most important pages below:
+## More Links
 
 - [Book](https://doc.redox-os.org/book/)
 - [Contribute](CONTRIBUTING.md)
-- [Hardware Compatibility](HARDWARE.md)
-- [Trying Out Redox](https://doc.redox-os.org/book/ch02-04-trying-out-redox.html)
-- [Building Redox](https://doc.redox-os.org/book/ch02-05-building-redox.html)
-- [Build System Documentation](https://doc.redox-os.org/book/ch08-06-build-system-reference.html)
-- [Developer FAQ](https://doc.redox-os.org/book/ch09-05-developer-faq.html)
-- [Chat/Discussions/Help](https://doc.redox-os.org/book/ch13-01-chat.html)
+- [Hardware Compatibility](https://doc.redox-os.org/book/hardware-support.html)
+- Run Redox in a [Virtual Machine](https://doc.redox-os.org/book/running-vm.html) or on [Real Hardware](https://doc.redox-os.org/book/real-hardware.html)
+- [Trying Out Redox](https://doc.redox-os.org/book/trying-out-redox.html)
+- [Building Redox](https://doc.redox-os.org/book/podman-build.html)
+- [Build System Documentation](https://doc.redox-os.org/book/build-system-reference.html)
+- [Developer FAQ](https://doc.redox-os.org/book/developer-faq.html)
+- [Chat/Discussions/Help](https://doc.redox-os.org/book/chat.html)
 
 ## Ecosystem
 
-These are the most important repositories available on the Redox GitLab:
+Some of the key repositories on the Redox GitLab:
 
-| Name (lexicographic order)                                                           | Maintainer
+| Essential Repos                                                                      | Maintainer
 |--------------------------------------------------------------------------------------|---------------------------
-| [acid (kernel integration tests)](https://gitlab.redox-os.org/redox-os/acid)         | **@jackpot51**
-| [binutils](https://gitlab.redox-os.org/redox-os/binutils)                            | **@jackpot51**
-| [cookbook](https://gitlab.redox-os.org/redox-os/cookbook)                            | **@jackpot51** **@hatred_45** **@ids1024**
-| [coreutils](https://gitlab.redox-os.org/redox-os/coreutils)                          | **@jackpot51**
-| [extrautils](https://gitlab.redox-os.org/redox-os/extrautils)                        | **@jackpot51**
-| [games](https://gitlab.redox-os.org/redox-os/games)                                  | **@fabiao**
-| [Ion (shell)](https://gitlab.redox-os.org/redox-os/ion)                              | **@jackpot51**
-| [ipcd](https://gitlab.redox-os.org/redox-os/ipcd)                                    | **@jackpot51**
-| [kernel](https://gitlab.redox-os.org/redox-os/kernel)                                | **@jackpot51**
-| [libextra](https://gitlab.redox-os.org/redox-os/libextra)                            | **@jackpot51**
-| [libpager](https://gitlab.redox-os.org/redox-os/libpager)                            | **@jackpot51**
-| [netstack](https://gitlab.redox-os.org/redox-os/netstack)                            | **@jackpot51**
-| [netutils](https://gitlab.redox-os.org/redox-os/netutils)                            | **@jackpot51**
-| [orbclient (Orbital client)](https://gitlab.redox-os.org/redox-os/orbclient)         | **@jackpot51** **@FloVanGH**
-| [orbdata](https://gitlab.redox-os.org/redox-os/orbdata)                              | **@jackpot51**
-| [orbgame (Orbital 2D game engine)](https://gitlab.redox-os.org/redox-os/orbgame)     | **@FloVanGH**
-| [Orbital (windowing and compositing system)](https://gitlab.redox-os.org/redox-os/orbital) | **@jackpot51**
-| [orbtk (Orbital toolkit)](https://gitlab.redox-os.org/redox-os/orbtk)                | **@FloVanGH**
-| [orbutils (Orbital utilities)](https://gitlab.redox-os.org/redox-os/orbutils)        | **@jackpot51**
+| [Kernel](https://gitlab.redox-os.org/redox-os/kernel)                                | **@jackpot51**
+| [RedoxFS (default filesystem)](https://gitlab.redox-os.org/redox-os/redoxfs)         | **@jackpot51**
+| [Drivers](https://gitlab.redox-os.org/redox-os/drivers)                              | **@jackpot51**
+| [Orbital (display server and window manager)](https://gitlab.redox-os.org/redox-os/orbital) | **@jackpot51**
 | [pkgutils (current package manager)](https://gitlab.redox-os.org/redox-os/pkgutils)  | **@jackpot51**
-| [ralloc](https://gitlab.redox-os.org/redox-os/ralloc)                                | **@jackpot51**
-| [RANSID (Rust ANSI driver)](https://gitlab.redox-os.org/redox-os/ransid)             | **@jackpot51**
-| [redoxfs (default filesystem)](https://gitlab.redox-os.org/redox-os/redoxfs)             | **@jackpot51**
-| [relibc (C Library in Rust)](https://gitlab.redox-os.org/redox-os/relibc)            | **@jackpot51**
-| [small (stack String and other collections)](https://gitlab.redox-os.org/redox-os/small) | **@jackpot51**
-| [syscall](https://gitlab.redox-os.org/redox-os/syscall)                              | **@jackpot51**
-| [Sodium (Vim-inspired text editor)](https://gitlab.redox-os.org/redox-os/sodium)     | **@jackpot51**
-| [The Redox book](https://gitlab.redox-os.org/redox-os/book)                          |    **@hatred_45**
-| [userutils](https://gitlab.redox-os.org/redox-os/userutils)                          | **@jackpot51**
+| [relibc (C POSIX library written in Rust)](https://gitlab.redox-os.org/redox-os/relibc)            | **@jackpot51**
+| [netstack (network stack)](https://gitlab.redox-os.org/redox-os/netstack)                            | **@jackpot51**
+| [Ion (defauilt shell)](https://gitlab.redox-os.org/redox-os/ion)                              | **@jackpot51**
+| [Termion (terminal library)](https://gitlab.redox-os.org/redox-os/termion)           | **@jackpot51**
+| This repo - the root of the Build System                                             | **@jackpot51**
+| [cookbook (Build system for system components and programs)](https://gitlab.redox-os.org/redox-os/cookbook) | **@jackpot51** **@hatred_45**
+| [Redoxer (Tool for Redox development testing)](https://gitlab.redox-os.org/redox-os/redoxer) | **@jackpot51**
+| [The Redox Book](https://gitlab.redox-os.org/redox-os/book)                          | **@hatred_45**
 
 ## What it looks like
 
-<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/Senza%20titolo.jpeg">
-<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/redox running.jpeg">
-<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/IMG_1460.PNG">
+See [Redox in Action](https://www.redox-os.org/screens/) for photos and videos.
 
-<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/Sodium_v2.PNG">
-<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/Boot.png">
-<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/IMG_1459.PNG">
+<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/website/-/raw/master/static/img/screenshot/orbital-visual.png">
+<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/website/-/raw/master/static/img/screenshot/cosmic-programs.png">
+<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/website/-/raw/master/static/img/screenshot/cosmic-term-screenfetch.png">
 
-See [Redox in Action](https://www.redox-os.org/screens/) for photos and videos.
\ No newline at end of file
+<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/website/-/raw/master/static/img/screenshot/cosmic-edit-redox.png">
+<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/website/-/raw/master/static/img/screenshot/image-viewer.png">
+<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/Boot.png">

build.sh

 #!/usr/bin/env bash
 
+# Alternative script for the build system Makefiles
+
 ###########################################################################
 #                                                                         #
 # Build the system, with a specified processor type and filesystem config #

config/aarch64/acid.toml

-# Configuration for using acid
+# Configuration to run the "acid" tests
 
 include = ["../acid.toml"]

config/aarch64/ci.toml

-# This is the CI configuration file
+# The Redox build server configuration
 
 # General settings
 [general]
@@ -64,7 +64,6 @@ gettext = {}
 gigalomania = {}
 git = {}
 glib = {}
-glium = {}
 glutin = {}
 gnu-binutils = {}
 gnu-grep = {}
@@ -72,16 +71,14 @@ gnu-make = {}
 #gstreamer = {} # conflict with thread local errno
 harfbuzz = {}
 #hematite = {} # needs crate patches for redox-unix
-init = {}
+hicolor-icon-theme = {}
 initfs = {}
 installer = {}
 installer-gui = {}
 intel-one-mono = {}
 ion = {}
-ipcd = {}
 jansson = {}
 kernel = {}
-keyboard-sfx = {}
 lci = {}
 libc-bench = {}
 libffi = {}
@@ -94,14 +91,14 @@ libpng = {}
 libsodium = {}
 libvorbis = {}
 libxml2 = {}
-llvm = {}
-logd = {}
+llvm18 = {}
 lua54 = {}
 #mdp = {} # ncursesw
 mesa = {}
 mesa-glu = {}
 mgba = {}
 #miniserve = {} # actix
+nano = {}
 nasm = {}
 #ncdu = {} # fails to link with ncurses
 ncurses = {}
@@ -147,11 +144,8 @@ pop-icon-theme = {}
 #powerline = {} # dirs
 prboom = {}
 procedural-wallpapers-rs = {}
-ptyd = {}
 #python = {} # getaddrinfo
 #qemu = {}
-ramfs = {}
-randd = {}
 readline = {}
 redoxerd = {}
 redox-fatfs = {}
@@ -208,5 +202,4 @@ vvvvvv = {}
 #wesnoth = {}
 #winit = {} # tzset
 xz = {}
-zerod = {}
 zlib = {}

config/aarch64/demo.toml

+# Configuration for demonstration
+
+include = ["desktop.toml"]

config/aarch64/desktop-minimal.toml

-# Default desktop configuration
+# Minimal desktop configuration
 
 include = ["../desktop-minimal.toml"]
 

config/aarch64/desktop.toml

+# Default build system configuration
+
+include = ["../minimal.toml"]
+
+# General settings
+[general]
+# Filesystem size in MiB
+filesystem_size = 256
+
+# Package settings
+[packages]
+audiod = {}
+cosmic-edit = {}
+cosmic-icons = {}
+cosmic-files = {}
+cosmic-term = {}
+orbdata = {}
+orbital = {}
+orbutils = {}
+pop-icon-theme = {}
+shared-mime-info = {}
+
+[[files]]
+path = "/usr/lib/init.d/20_orbital"
+data = """
+audiod
+export VT 3
+orbital orblogin launcher
+unset VT
+"""

config/aarch64/jeremy.toml

+# Configuration for Jeremy Soller
+
+include = ["desktop.toml"]

config/aarch64/minimal-net.toml

+# Minimal network configuration
+
+include = ["../minimal-net.toml"]
+
+# Override the default settings here
+
+# General settings
+[general]
+# Filesystem size in MiB
+# filesystem_size = 1024
+
+# Package settings
+[packages]
+# example = {}
\ No newline at end of file

config/x86_64/server-minimal.toml → config/aarch64/minimal.toml

 # Minimal configuration
 
-include = ["../server-minimal.toml"]
+include = ["../minimal.toml"]
 
 # Override the default settings here
 

config/aarch64/raspi3bp/server-minimal.toml → config/aarch64/raspi3bp/minimal.toml

 # Minimal configuration
 
-include = ["../../server-minimal.toml"]
+include = ["../../minimal.toml"]
 
 # General settings
 [general]

config/aarch64/resist.toml

-# Configuration for using resist
+# Configuration to run the "resist" tests
 
 include = ["../resist.toml"]

config/aarch64/server.toml

+# Server configuration
+
+include = ["../server.toml"]
+
+# Override the default settings here
+
+# General settings
+[general]
+# Filesystem size in MiB
+# filesystem_size = 1024
+
+# Package settings
+[packages]
+# example = {}
\ No newline at end of file

config/acid.toml

-# Configuration for using acid
+# Configuration to run the "acid" tests
 
 include = ["base.toml"]