Add explanation comments on the build system files

.gitlab-ci.yml

@@ -1,3 +1,4 @@
+# The GitLab Continuous Integration configuration
 image: "ubuntu:22.04"
 
 variables:

Makefile

@@ -1,7 +1,8 @@
-# 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

bootstrap.sh

@@ -1,3 +1,7 @@
+# This script setup the Redox build system
+# It install Rustup, the recipe dependencies for cross-compilation
+# and download the build system configuration files
+
 #!/usr/bin/env bash
 
 set -e

build.sh

@@ -1,3 +1,5 @@
+# Alternative script for the build system Makefiles
+
 #!/usr/bin/env bash
 
 ###########################################################################

config/aarch64/acid.toml

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

config/aarch64/ci.toml

@@ -1,4 +1,4 @@
-# This is the CI configuration file
+# The Redox build server configuration
 
 # General settings
 [general]

config/aarch64/demo.toml

@@ -1 +1,3 @@
+# Configuration for demonstration
+
 include = ["desktop.toml"]

config/aarch64/desktop-minimal.toml

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

config/aarch64/desktop.toml

@@ -1,4 +1,4 @@
-# Default desktop configuration
+# Default build system configuration
 
 include = ["../minimal.toml"]
 

config/aarch64/jeremy.toml

@@ -1 +1,3 @@
+# Configuration for Jeremy Soller
+
 include = ["desktop.toml"]

config/aarch64/minimal-net.toml

@@ -1,4 +1,4 @@
-# Minimal configuration
+# Minimal network configuration
 
 include = ["../minimal-net.toml"]
 

config/aarch64/resist.toml

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

config/aarch64/server.toml

@@ -1,4 +1,4 @@
-# Default server configuration
+# Server configuration
 
 include = ["../server.toml"]
 

config/acid.toml

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

config/desktop-minimal.toml

@@ -1,4 +1,4 @@
-# Default desktop configuration
+# Minimal desktop configuration
 
 include = ["minimal-net.toml"]
 

config/desktop.toml

@@ -1,4 +1,4 @@
-# Default desktop configuration
+# Default build system configuration
 
 include = ["server.toml"]
 

config/dev.toml

@@ -1,4 +1,4 @@
-# Configuration for development, includes cargo and rustc
+# Configuration for development
 
 include = ["desktop.toml"]
 

config/i686/acid.toml

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

config/i686/ci.toml

@@ -1,4 +1,4 @@
-# This is the CI configuration file
+# The Redox build server configuration
 
 # General settings
 [general]

config/i686/demo.toml

@@ -1,3 +1,4 @@
+# Configuration for demonstration
 ##############################################################################
 #                          Redox Demo Configuration                          #
 #                                                                            #