From 49102f63325baee0040a224fbec07a538207c181 Mon Sep 17 00:00:00 2001 From: Ribbon Date: Tue, 9 Jul 2024 12:58:07 +0000 Subject: [PATCH] Add explanation comments on the build system files --- .gitlab-ci.yml | 1 + Makefile | 5 +++-- bootstrap.sh | 4 ++++ build.sh | 2 ++ config/aarch64/acid.toml | 2 +- config/aarch64/ci.toml | 2 +- config/aarch64/demo.toml | 2 ++ config/aarch64/desktop-minimal.toml | 2 +- config/aarch64/desktop.toml | 2 +- config/aarch64/jeremy.toml | 2 ++ config/aarch64/minimal-net.toml | 2 +- config/aarch64/resist.toml | 2 +- config/aarch64/server.toml | 2 +- config/acid.toml | 2 +- config/desktop-minimal.toml | 2 +- config/desktop.toml | 2 +- config/dev.toml | 2 +- config/i686/acid.toml | 2 +- config/i686/ci.toml | 2 +- config/i686/demo.toml | 1 + config/i686/desktop-minimal.toml | 2 +- config/i686/desktop.toml | 2 +- config/i686/dev.toml | 2 +- config/i686/jeremy.toml | 2 +- config/i686/minimal-net.toml | 2 +- config/i686/resist.toml | 2 +- config/i686/server.toml | 2 +- config/llvm.toml | 2 +- config/net.toml | 2 +- config/redoxer-gui.toml | 2 +- config/redoxer.toml | 2 +- config/resist.toml | 2 +- config/server.toml | 2 +- config/x86_64/acid.toml | 2 +- config/x86_64/ci.toml | 2 +- config/x86_64/demo.toml | 1 + config/x86_64/desktop-contain.toml | 2 +- config/x86_64/desktop-minimal.toml | 2 +- config/x86_64/desktop.toml | 2 +- config/x86_64/dev.toml | 2 +- config/x86_64/jeremy.toml | 2 +- config/x86_64/llvm.toml | 2 +- config/x86_64/minimal-net.toml | 2 +- config/x86_64/resist.toml | 2 +- config/x86_64/server.toml | 2 +- docker/Dockerfile | 2 ++ docker/docker.sh | 2 ++ mk/ci.mk | 2 ++ mk/config.mk | 2 ++ mk/depends.mk | 2 +- mk/disk.mk | 2 ++ mk/fstools.mk | 2 ++ mk/podman.mk | 4 +--- mk/prefix.mk | 2 ++ mk/qemu.mk | 2 ++ mk/repo.mk | 2 ++ mk/virtualbox.mk | 2 ++ podman/redox-base-containerfile | 2 ++ podman/rustinstall.sh | 5 +++-- podman_bootstrap.sh | 4 ++++ scripts/backtrace.sh | 3 +++ scripts/category.sh | 2 ++ scripts/changelog.sh | 2 ++ scripts/commit-hash.sh | 2 ++ scripts/dual-boot.sh | 3 +++ scripts/find-recipe.sh | 2 ++ scripts/include-recipes.sh | 4 ++++ scripts/pkg-size.sh | 3 +++ scripts/show-package.sh | 4 ++-- scripts/ventoy.sh | 2 ++ 70 files changed, 109 insertions(+), 47 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e4130aeb5..96432e74d 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,3 +1,4 @@ +# The GitLab Continuous Integration configuration image: "ubuntu:22.04" variables: diff --git a/Makefile b/Makefile index 9cfbadb5a..18b41165e 100644 --- a/Makefile +++ b/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 diff --git a/bootstrap.sh b/bootstrap.sh index 8bf53e644..ec201c8dd 100755 --- a/bootstrap.sh +++ b/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 diff --git a/build.sh b/build.sh index 379bd7495..6f0d1995c 100755 --- a/build.sh +++ b/build.sh @@ -1,3 +1,5 @@ +# Alternative script for the build system Makefiles + #!/usr/bin/env bash ########################################################################### diff --git a/config/aarch64/acid.toml b/config/aarch64/acid.toml index f52664fc4..ef2ba347f 100644 --- 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"] diff --git a/config/aarch64/ci.toml b/config/aarch64/ci.toml index 5652afd11..2cea6c46f 100644 --- 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] diff --git a/config/aarch64/demo.toml b/config/aarch64/demo.toml index e27856138..1f6e59b5e 100644 --- a/config/aarch64/demo.toml +++ b/config/aarch64/demo.toml @@ -1 +1,3 @@ +# Configuration for demonstration + include = ["desktop.toml"] diff --git a/config/aarch64/desktop-minimal.toml b/config/aarch64/desktop-minimal.toml index c2db3ecae..fb09c1d09 100644 --- 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"] diff --git a/config/aarch64/desktop.toml b/config/aarch64/desktop.toml index 9b3807dcc..e95fbfec8 100644 --- a/config/aarch64/desktop.toml +++ b/config/aarch64/desktop.toml @@ -1,4 +1,4 @@ -# Default desktop configuration +# Default build system configuration include = ["../minimal.toml"] diff --git a/config/aarch64/jeremy.toml b/config/aarch64/jeremy.toml index e27856138..f3d8c0abc 100644 --- a/config/aarch64/jeremy.toml +++ b/config/aarch64/jeremy.toml @@ -1 +1,3 @@ +# Configuration for Jeremy Soller + include = ["desktop.toml"] diff --git a/config/aarch64/minimal-net.toml b/config/aarch64/minimal-net.toml index eae1e8066..bcdb3af01 100644 --- 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"] diff --git a/config/aarch64/resist.toml b/config/aarch64/resist.toml index dbf3e13d6..60ac1e55b 100644 --- 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"] diff --git a/config/aarch64/server.toml b/config/aarch64/server.toml index ee6eed7c5..978aa0d0f 100644 --- a/config/aarch64/server.toml +++ b/config/aarch64/server.toml @@ -1,4 +1,4 @@ -# Default server configuration +# Server configuration include = ["../server.toml"] diff --git a/config/acid.toml b/config/acid.toml index bea9a6839..e2853d75e 100644 --- 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"] diff --git a/config/desktop-minimal.toml b/config/desktop-minimal.toml index 84ea9ebc9..16e440fc8 100644 --- a/config/desktop-minimal.toml +++ b/config/desktop-minimal.toml @@ -1,4 +1,4 @@ -# Default desktop configuration +# Minimal desktop configuration include = ["minimal-net.toml"] diff --git a/config/desktop.toml b/config/desktop.toml index a3d52c8be..01ecfe670 100644 --- a/config/desktop.toml +++ b/config/desktop.toml @@ -1,4 +1,4 @@ -# Default desktop configuration +# Default build system configuration include = ["server.toml"] diff --git a/config/dev.toml b/config/dev.toml index 6c16473f9..ee395af5d 100644 --- 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"] diff --git a/config/i686/acid.toml b/config/i686/acid.toml index f52664fc4..ef2ba347f 100644 --- 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"] diff --git a/config/i686/ci.toml b/config/i686/ci.toml index e979afbf4..c94cff54d 100644 --- 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] diff --git a/config/i686/demo.toml b/config/i686/demo.toml index 45b812463..7e325b891 100644 --- a/config/i686/demo.toml +++ b/config/i686/demo.toml @@ -1,3 +1,4 @@ +# Configuration for demonstration ############################################################################## # Redox Demo Configuration # # # diff --git a/config/i686/desktop-minimal.toml b/config/i686/desktop-minimal.toml index c2db3ecae..fb09c1d09 100644 --- 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"] diff --git a/config/i686/desktop.toml b/config/i686/desktop.toml index 5b89db83b..ab1670ba4 100644 --- a/config/i686/desktop.toml +++ b/config/i686/desktop.toml @@ -1,4 +1,4 @@ -# Default desktop configuration +# Default build system configuration include = ["../desktop.toml"] diff --git a/config/i686/dev.toml b/config/i686/dev.toml index 4dcc8412c..ecd30849a 100644 --- 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"] diff --git a/config/i686/jeremy.toml b/config/i686/jeremy.toml index c3af4966d..c3bc2b520 100644 --- a/config/i686/jeremy.toml +++ b/config/i686/jeremy.toml @@ -1,4 +1,4 @@ -# Jeremy's configuration +# Configuration for Jeremy Soller include = ["../desktop.toml"] diff --git a/config/i686/minimal-net.toml b/config/i686/minimal-net.toml index eae1e8066..bcdb3af01 100644 --- 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"] diff --git a/config/i686/resist.toml b/config/i686/resist.toml index dbf3e13d6..1eecccf9e 100644 --- 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"] diff --git a/config/i686/server.toml b/config/i686/server.toml index ee6eed7c5..978aa0d0f 100644 --- a/config/i686/server.toml +++ b/config/i686/server.toml @@ -1,4 +1,4 @@ -# Default server configuration +# Server configuration include = ["../server.toml"] diff --git a/config/llvm.toml b/config/llvm.toml index eed9947a6..84d3faa7c 100644 --- a/config/llvm.toml +++ b/config/llvm.toml @@ -1,4 +1,4 @@ -# Default desktop configuration +# # Configuration to create "llvm-config" script include = ["base.toml"] diff --git a/config/net.toml b/config/net.toml index 5899b6e6b..bf4d740c8 100644 --- 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"] diff --git a/config/redoxer-gui.toml b/config/redoxer-gui.toml index 568c5a0c7..cd474ed33 100644 --- 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"] diff --git a/config/redoxer.toml b/config/redoxer.toml index 12461938e..dde793a07 100644 --- a/config/redoxer.toml +++ b/config/redoxer.toml @@ -1,4 +1,4 @@ -# Configuration for redoxer image +# Configuration for the Redoxer image include = ["net.toml"] diff --git a/config/resist.toml b/config/resist.toml index 499b0c655..b25279fdf 100644 --- 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"] diff --git a/config/server.toml b/config/server.toml index 0b0ca05c3..098818286 100644 --- a/config/server.toml +++ b/config/server.toml @@ -1,4 +1,4 @@ -# Default server configuration +# Server configuration include = ["net.toml"] diff --git a/config/x86_64/acid.toml b/config/x86_64/acid.toml index f52664fc4..f89bdea88 100644 --- 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"] diff --git a/config/x86_64/ci.toml b/config/x86_64/ci.toml index 18c06da46..14be0b6b8 100644 --- 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] diff --git a/config/x86_64/demo.toml b/config/x86_64/demo.toml index 8c5b31506..94f4adf75 100644 --- a/config/x86_64/demo.toml +++ b/config/x86_64/demo.toml @@ -1,3 +1,4 @@ +# Configuration for demonstration ############################################################################## # Redox Demo Configuration # # # diff --git a/config/x86_64/desktop-contain.toml b/config/x86_64/desktop-contain.toml index 58b292701..97d6765cc 100644 --- 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"] diff --git a/config/x86_64/desktop-minimal.toml b/config/x86_64/desktop-minimal.toml index c2db3ecae..fb09c1d09 100644 --- 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"] diff --git a/config/x86_64/desktop.toml b/config/x86_64/desktop.toml index 5b89db83b..ab1670ba4 100644 --- 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"] diff --git a/config/x86_64/dev.toml b/config/x86_64/dev.toml index 4dcc8412c..ecd30849a 100644 --- 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"] diff --git a/config/x86_64/jeremy.toml b/config/x86_64/jeremy.toml index 29a71b21a..58579386d 100644 --- 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"] diff --git a/config/x86_64/llvm.toml b/config/x86_64/llvm.toml index 1c0a3fea5..5aa7e94bc 100644 --- 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"] diff --git a/config/x86_64/minimal-net.toml b/config/x86_64/minimal-net.toml index eae1e8066..bcdb3af01 100644 --- 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"] diff --git a/config/x86_64/resist.toml b/config/x86_64/resist.toml index dbf3e13d6..60ac1e55b 100644 --- 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"] diff --git a/config/x86_64/server.toml b/config/x86_64/server.toml index ee6eed7c5..978aa0d0f 100644 --- a/config/x86_64/server.toml +++ b/config/x86_64/server.toml @@ -1,4 +1,4 @@ -# Default server configuration +# Server configuration include = ["../server.toml"] diff --git a/docker/Dockerfile b/docker/Dockerfile index 6c5755503..d9bb26e02 100755 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -1,3 +1,5 @@ +# Configuration file to setup the Docker container of Redox + FROM rustlang/rust:nightly ENV IMAGE_NAME=redox-os-docker diff --git a/docker/docker.sh b/docker/docker.sh index 3d7f13ba9..63bc5ddca 100755 --- a/docker/docker.sh +++ b/docker/docker.sh @@ -1,3 +1,5 @@ +# This script run the Docker image of Redox + docker run --privileged --cap-add MKNOD --cap-add SYS_ADMIN --device /dev/fuse \ -e LOCAL_UID="$(id -u)" -e LOCAL_GID="$(id -g)" \ -v redox-"$(id -u)-$(id -g)"-cargo:/usr/local/cargo \ diff --git a/mk/ci.mk b/mk/ci.mk index 38a5073ec..5a4803d47 100644 --- a/mk/ci.mk +++ b/mk/ci.mk @@ -1,3 +1,5 @@ +# Configuration file of the build system commands for the build server + IMG_TAG?=$(shell git describe --tags) IMG_SEPARATOR?=_ IMG_DIR?=build/img/$(ARCH) diff --git a/mk/config.mk b/mk/config.mk index 59f5be055..5a7adfdb7 100644 --- a/mk/config.mk +++ b/mk/config.mk @@ -1,3 +1,5 @@ +# Configuration file of the build system environment variables + -include .config HOST_ARCH?=$(shell uname -m) diff --git a/mk/depends.mk b/mk/depends.mk index fd4f85389..30cf2d75f 100644 --- a/mk/depends.mk +++ b/mk/depends.mk @@ -1,4 +1,4 @@ -# Dependencies +# Configuration file for the build system dependencies # Don't check for Rust/Cargo if you will be using Podman ifneq ($(PODMAN_BUILD),1) diff --git a/mk/disk.mk b/mk/disk.mk index 7acfed448..9b37e9468 100644 --- a/mk/disk.mk +++ b/mk/disk.mk @@ -1,3 +1,5 @@ +# Configuration file with the commands configuration of the Redox image + $(BUILD)/harddrive.img: $(FSTOOLS_TAG) $(REPO_TAG) mkdir -p $(BUILD) rm -rf $@ $@.partial diff --git a/mk/fstools.mk b/mk/fstools.mk index eade34937..9a55984dc 100644 --- a/mk/fstools.mk +++ b/mk/fstools.mk @@ -1,3 +1,5 @@ +# Configuration file for redox-installer, Cookbook and RedoxFS FUSE + fstools: $(FSTOOLS_TAG) $(FSTOOLS_TAG): cookbook installer redoxfs $(CONTAINER_TAG) diff --git a/mk/podman.mk b/mk/podman.mk index a005d0ef9..cd9e2141f 100644 --- a/mk/podman.mk +++ b/mk/podman.mk @@ -1,6 +1,4 @@ -############################################## -# podman.mk - Use Podman to build components # -############################################## +# Configuration file of the Podman commands # Configuration variables for running make in Podman ## Tag the podman image $IMAGE_TAG diff --git a/mk/prefix.mk b/mk/prefix.mk index dd57d9bf3..98351283b 100644 --- a/mk/prefix.mk +++ b/mk/prefix.mk @@ -1,3 +1,5 @@ +# Configuration file for the Rust/GCC cross-compilers and relibc + PREFIX=prefix/$(TARGET) PREFIX_INSTALL=$(PREFIX)/relibc-install diff --git a/mk/qemu.mk b/mk/qemu.mk index 129183164..5077b7d55 100644 --- a/mk/qemu.mk +++ b/mk/qemu.mk @@ -1,3 +1,5 @@ +# Configuration file for QEMU + QEMU=SDL_VIDEO_X11_DGAMOUSE=0 qemu-system-$(QEMU_ARCH) QEMUFLAGS=-d guest_errors -name "Redox OS $(ARCH)" diff --git a/mk/repo.mk b/mk/repo.mk index 863a76b87..0291c6832 100644 --- a/mk/repo.mk +++ b/mk/repo.mk @@ -1,3 +1,5 @@ +# Configuration file for recipe commands + $(BUILD)/fetch.tag: prefix $(FSTOOLS_TAG) $(FILESYSTEM_CONFIG) $(CONTAINER_TAG) ifeq ($(PODMAN_BUILD),1) $(PODMAN_RUN) $(MAKE) $@ diff --git a/mk/virtualbox.mk b/mk/virtualbox.mk index 434adf53b..5f84fff69 100644 --- a/mk/virtualbox.mk +++ b/mk/virtualbox.mk @@ -1,3 +1,5 @@ +# Configuration file for VirtualBox, it creates a VirtualBox virtual machine + virtualbox: $(BUILD)/harddrive.img echo "Delete VM" -$(VBM) unregistervm Redox --delete; \ diff --git a/podman/redox-base-containerfile b/podman/redox-base-containerfile index 62f11eec8..e6949283e 100644 --- a/podman/redox-base-containerfile +++ b/podman/redox-base-containerfile @@ -1,3 +1,5 @@ +# Configuration file to install the recipe dependencies inside the Podman container + FROM debian:bookworm-20240513-slim # _UID_ must be replaced with the user's uid on host diff --git a/podman/rustinstall.sh b/podman/rustinstall.sh index 89749af4f..beacf2aaf 100755 --- a/podman/rustinstall.sh +++ b/podman/rustinstall.sh @@ -1,6 +1,7 @@ -#/usr/bin/env bash +# This script install the Rust toolchain and the build system dependencies +# in Podman after the image has been built -# Install Rust in Podman, after the image has been built +#/usr/bin/env bash curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain stable cargo +stable install --force --version 0.1.1 cargo-config diff --git a/podman_bootstrap.sh b/podman_bootstrap.sh index 4bdeafd27..1a4ff3be4 100755 --- a/podman_bootstrap.sh +++ b/podman_bootstrap.sh @@ -1,3 +1,7 @@ +# This script setup the Redox build system with Podman +# It install the Podman dependencies, Rustup, recipes dependencies for cross-compilation +# and download the build system configuration files + #!/usr/bin/env bash set -e diff --git a/scripts/backtrace.sh b/scripts/backtrace.sh index 02e88017d..d0389e0d6 100755 --- a/scripts/backtrace.sh +++ b/scripts/backtrace.sh @@ -1,3 +1,6 @@ +# This script allow the user to copy a Rust backtrace from Redox +# and retrieve the symbols + #!/usr/bin/env bash usage() diff --git a/scripts/category.sh b/scripts/category.sh index faca2034b..5a08f1494 100755 --- a/scripts/category.sh +++ b/scripts/category.sh @@ -1,3 +1,5 @@ +# This script run the recipe command options on some Cookbook category + #!/usr/bin/env bash if [ -z "$1" ] || [ -z "$2" ] diff --git a/scripts/changelog.sh b/scripts/changelog.sh index 34311f1bb..6eef235a7 100755 --- a/scripts/changelog.sh +++ b/scripts/changelog.sh @@ -1,3 +1,5 @@ +# This script show the changelog of all Redox components + #!/usr/bin/env bash set -e diff --git a/scripts/commit-hash.sh b/scripts/commit-hash.sh index a06e10644..96d16fc0a 100755 --- a/scripts/commit-hash.sh +++ b/scripts/commit-hash.sh @@ -1,3 +1,5 @@ +# This script show the current Git branch and commit of the recipe source + #!/usr/bin/env bash if [ $# -ne 1 ] diff --git a/scripts/dual-boot.sh b/scripts/dual-boot.sh index 898b21e29..196a5bd5e 100755 --- a/scripts/dual-boot.sh +++ b/scripts/dual-boot.sh @@ -1,3 +1,6 @@ +# This script install Redox in the free space of your storage device +# and add a boot entry (if you are using the systemd-boot boot loader) + #!/usr/bin/env bash set -e diff --git a/scripts/find-recipe.sh b/scripts/find-recipe.sh index 61fb277cf..4de00ecc8 100755 --- a/scripts/find-recipe.sh +++ b/scripts/find-recipe.sh @@ -1,3 +1,5 @@ +# This script show all files installed by a recipe + #!/usr/bin/env bash # Ensure arch and config are set as desired, we use these to find the build dir diff --git a/scripts/include-recipes.sh b/scripts/include-recipes.sh index 5d2b53044..a38c1c937 100755 --- a/scripts/include-recipes.sh +++ b/scripts/include-recipes.sh @@ -1,3 +1,7 @@ +# This script create a list with: +# "recipe-name = {} #TODO" +# For quick testing of WIP recipes + #!/usr/bin/env bash # Given a string, find recipe.toml files containing that string. diff --git a/scripts/pkg-size.sh b/scripts/pkg-size.sh index 59b816797..0acc6d211 100755 --- a/scripts/pkg-size.sh +++ b/scripts/pkg-size.sh @@ -1,3 +1,6 @@ +# This script show the package size of the recipes ("stage.pkgar" and "stage.tar.gz") +# It must be used by package maintainers to enforce the library linking size policy + #!/usr/bin/env bash if [ $# = 0 ] diff --git a/scripts/show-package.sh b/scripts/show-package.sh index e7941d650..1b43c94bc 100755 --- a/scripts/show-package.sh +++ b/scripts/show-package.sh @@ -1,6 +1,6 @@ -#!/usr/bin/env bash +# This script show the contents of the "stage" and "sysroot" folders in some recipe -# Show the contents of the stage and sysroot folders in some recipe +#!/usr/bin/env bash if [ -z "$*" ] then diff --git a/scripts/ventoy.sh b/scripts/ventoy.sh index 37f6e4dd1..34263a55b 100755 --- a/scripts/ventoy.sh +++ b/scripts/ventoy.sh @@ -1,3 +1,5 @@ +# This script create and copy the Redox bootable image to an Ventoy-formatted device + #!/usr/bin/env bash set -e