Add explanation comments on the build system files

2024-07-09 12:58:07 +00:00 · 2024-07-09 12:58:07 +00:00 · 49102f6332
commit 49102f6332
parent 06f038eced
70 changed files with 109 additions and 47 deletions
--- a/config/aarch64/acid.toml
+++ b/config/aarch64/acid.toml
@ -1,3 +1,3 @@
-# Configuration for using acid
+# Configuration to run the "acid" tests

 include = ["../acid.toml"]
--- a/config/aarch64/ci.toml
+++ b/config/aarch64/ci.toml
@ -1,4 +1,4 @@
-# This is the CI configuration file
+# The Redox build server configuration

 # General settings
 [general]
--- a/config/aarch64/demo.toml
+++ b/config/aarch64/demo.toml
@ -1 +1,3 @@
+# Configuration for demonstration
+
 include = ["desktop.toml"]
--- a/config/aarch64/desktop-minimal.toml
+++ b/config/aarch64/desktop-minimal.toml
@ -1,4 +1,4 @@
-# Default desktop configuration
+# Minimal desktop configuration

 include = ["../desktop-minimal.toml"]

--- a/config/aarch64/desktop.toml
+++ b/config/aarch64/desktop.toml
@ -1,4 +1,4 @@
-# Default desktop configuration
+# Default build system configuration

 include = ["../minimal.toml"]

--- a/config/aarch64/jeremy.toml
+++ b/config/aarch64/jeremy.toml
@ -1 +1,3 @@
+# Configuration for Jeremy Soller
+
 include = ["desktop.toml"]
--- a/config/aarch64/minimal-net.toml
+++ b/config/aarch64/minimal-net.toml
@ -1,4 +1,4 @@
-# Minimal configuration
+# Minimal network configuration

 include = ["../minimal-net.toml"]

--- a/config/aarch64/resist.toml
+++ b/config/aarch64/resist.toml
@ -1,3 +1,3 @@
-# Configuration for using resist
+# Configuration to run the "resist" tests

 include = ["../resist.toml"]
--- a/config/aarch64/server.toml
+++ b/config/aarch64/server.toml
@ -1,4 +1,4 @@
-# Default server configuration
+# Server configuration

 include = ["../server.toml"]

--- a/config/acid.toml
+++ b/config/acid.toml
@ -1,4 +1,4 @@
-# Configuration for using acid
+# Configuration to run the "acid" tests

 include = ["base.toml"]

--- a/config/desktop-minimal.toml
+++ b/config/desktop-minimal.toml
@ -1,4 +1,4 @@
-# Default desktop configuration
+# Minimal desktop configuration

 include = ["minimal-net.toml"]

--- a/config/desktop.toml
+++ b/config/desktop.toml
@ -1,4 +1,4 @@
-# Default desktop configuration
+# Default build system configuration

 include = ["server.toml"]

--- a/config/dev.toml
+++ b/config/dev.toml
@ -1,4 +1,4 @@
-# Configuration for development, includes cargo and rustc
+# Configuration for development

 include = ["desktop.toml"]

--- a/config/i686/acid.toml
+++ b/config/i686/acid.toml
@ -1,3 +1,3 @@
-# Configuration for using acid
+# Configuration to run the "acid" tests

 include = ["../acid.toml"]
--- a/config/i686/ci.toml
+++ b/config/i686/ci.toml
@ -1,4 +1,4 @@
-# This is the CI configuration file
+# The Redox build server configuration

 # General settings
 [general]
--- a/config/i686/demo.toml
+++ b/config/i686/demo.toml
@ -1,3 +1,4 @@
+# Configuration for demonstration
 ##############################################################################
 #                          Redox Demo Configuration                          #
 #                                                                            #
--- a/config/i686/desktop-minimal.toml
+++ b/config/i686/desktop-minimal.toml
@ -1,4 +1,4 @@
-# Default desktop configuration
+# Minimal desktop configuration

 include = ["../desktop-minimal.toml"]

--- a/config/i686/desktop.toml
+++ b/config/i686/desktop.toml
@ -1,4 +1,4 @@
-# Default desktop configuration
+# Default build system configuration

 include = ["../desktop.toml"]

--- a/config/i686/dev.toml
+++ b/config/i686/dev.toml
@ -1,4 +1,4 @@
-# Configuration for development, includes cargo and rustc
+# Configuration for development

 include = ["../dev.toml"]

--- a/config/i686/jeremy.toml
+++ b/config/i686/jeremy.toml
@ -1,4 +1,4 @@
-# Jeremy's configuration
+# Configuration for Jeremy Soller

 include = ["../desktop.toml"]

--- a/config/i686/minimal-net.toml
+++ b/config/i686/minimal-net.toml
@ -1,4 +1,4 @@
-# Minimal configuration
+# Minimal network configuration

 include = ["../minimal-net.toml"]

--- a/config/i686/resist.toml
+++ b/config/i686/resist.toml
@ -1,3 +1,3 @@
-# Configuration for using resist
+# Configuration to use the "resist" tests

 include = ["../resist.toml"]
--- a/config/i686/server.toml
+++ b/config/i686/server.toml
@ -1,4 +1,4 @@
-# Default server configuration
+# Server configuration

 include = ["../server.toml"]

--- a/config/llvm.toml
+++ b/config/llvm.toml
@ -1,4 +1,4 @@
-# Default desktop configuration
+# # Configuration to create "llvm-config" script

 include = ["base.toml"]

--- a/config/net.toml
+++ b/config/net.toml
@ -1,4 +1,4 @@
-# Net configuration: includes the base configuration and adds files required
+# Network configuration: includes the base configuration and adds files required
 # for networking

 include = ["base.toml"]
--- a/config/redoxer-gui.toml
+++ b/config/redoxer-gui.toml
@ -1,4 +1,4 @@
-# Configuration for redoxer GUI image
+# Configuration for the Redoxer GUI image

 include = ["redoxer.toml"]

--- a/config/redoxer.toml
+++ b/config/redoxer.toml
@ -1,4 +1,4 @@
-# Configuration for redoxer image
+# Configuration for the Redoxer image

 include = ["net.toml"]

--- a/config/resist.toml
+++ b/config/resist.toml
@ -1,4 +1,4 @@
-# Configuration for using resist
+# Configuration to run the "resist" tests

 include = ["net.toml"]

--- a/config/server.toml
+++ b/config/server.toml
@ -1,4 +1,4 @@
-# Default server configuration
+# Server configuration

 include = ["net.toml"]

--- a/config/x86_64/acid.toml
+++ b/config/x86_64/acid.toml
@ -1,3 +1,3 @@
-# Configuration for using acid
+# Configuration to use the "acid" tests

 include = ["../acid.toml"]
--- a/config/x86_64/ci.toml
+++ b/config/x86_64/ci.toml
@ -1,4 +1,4 @@
-# This is the CI configuration file
+# The Redox build server configuration

 # General settings
 [general]
--- a/config/x86_64/demo.toml
+++ b/config/x86_64/demo.toml
@ -1,3 +1,4 @@
+# Configuration for demonstration
 ##############################################################################
 #                          Redox Demo Configuration                          #
 #                                                                            #
--- a/config/x86_64/desktop-contain.toml
+++ b/config/x86_64/desktop-contain.toml
@ -1,4 +1,4 @@
-# Default desktop configuration using contain
+# Desktop configuration using the Contain sandbox

 include = ["../desktop.toml"]

--- a/config/x86_64/desktop-minimal.toml
+++ b/config/x86_64/desktop-minimal.toml
@ -1,4 +1,4 @@
-# Default desktop configuration
+# Minimal desktop configuration

 include = ["../desktop-minimal.toml"]

--- a/config/x86_64/desktop.toml
+++ b/config/x86_64/desktop.toml
@ -1,4 +1,4 @@
-# Default desktop configuration
+# Default build system configuration

 include = ["../desktop.toml"]

--- a/config/x86_64/dev.toml
+++ b/config/x86_64/dev.toml
@ -1,4 +1,4 @@
-# Configuration for development, includes cargo and rustc
+# Configuration for development

 include = ["../dev.toml"]

--- a/config/x86_64/jeremy.toml
+++ b/config/x86_64/jeremy.toml
@ -1,4 +1,4 @@
-# Jeremy's configuration
+# Configuration for Jeremy Soller

 include = ["../desktop.toml"]

--- a/config/x86_64/llvm.toml
+++ b/config/x86_64/llvm.toml
@ -1,3 +1,3 @@
-# Config for creating llvm-config script
+# Configuration to create "llvm-config" script

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

 include = ["../minimal-net.toml"]

--- a/config/x86_64/resist.toml
+++ b/config/x86_64/resist.toml
@ -1,3 +1,3 @@
-# Configuration for using resist
+# Configuration to run the "resist" tests

 include = ["../resist.toml"]
--- a/config/x86_64/server.toml
+++ b/config/x86_64/server.toml
@ -1,4 +1,4 @@
-# Default server configuration
+# Server configuration

 include = ["../server.toml"]