From f8faf2803dcbc76823b701d848f7c27c9307e926 Mon Sep 17 00:00:00 2001 From: Denis 'GNUtoo' Carikli Date: Wed, 17 Apr 2024 18:56:06 +0200 Subject: [PATCH] Makefile.am: Document commands from site/docs/build/index.md. The build documentation (site/docs/build/index.md) references some commands, so documenting them in the a 'make help' command as well can help improve the contributors efficiency by not having to re-read the documentation every time we are looking for a command. In addition this can help separate well known commands from other less documented ones that are internal to GNU Boot and that can more easily change. This is also important as it allows, if the need arrise, to have the the autotools system play a more important role than merely a "compatibility system" for people used to type "make" as the build instructions currently state. Signed-off-by: Denis 'GNUtoo' Carikli Acked-by: Adrien 'neox' Bourmault --- Makefile.am | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/Makefile.am b/Makefile.am index 7cc850e..c5af88f 100644 --- a/Makefile.am +++ b/Makefile.am @@ -107,3 +107,16 @@ check: set -o pipefail ; ./tests/distclean | tee -a $(LOG) set -o pipefail ; ./tests/targets 2>&1 | tee -a $(LOG) @echo "[ OK ] Makefile: $@ target. See $(LOG) for the log." + +help: + @printf "Available commands:\n" + @printf "\tsudo make install-dependencies-ubuntu # %s\n" \ + "Install required dependencies on Ubuntu." + @printf "\tsudo make install-dependencies-pureos-10 # %s\n" \ + "Install required dependencies on PureOS 10 (byzantium)." + @printf "\tmake release # %s\n" \ + "Build a GNU Boot release." + @printf "\tmake clean # %s\n" \ + "Remove all the files being built in GNU Boot." + @printf "\tmake crossgcc-clean # %s\n" \ + "Remove the builds of the crossgcc toolchain."