[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v1 13/14] Makefile.am: Document commands from site/docs/build/ind
From: |
Denis 'GNUtoo' Carikli |
Subject: |
[PATCH v1 13/14] Makefile.am: Document commands from site/docs/build/index.md. |
Date: |
Fri, 19 Apr 2024 19:06:30 +0200 |
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 <GNUtoo@cyberdimension.org>
---
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."
--
2.41.0
- [PATCH v1 06/14] scripts: misc: guix.sh: fix forgetten tab., (continued)
- [PATCH v1 06/14] scripts: misc: guix.sh: fix forgetten tab., Denis 'GNUtoo' Carikli, 2024/04/19
- [PATCH v1 07/14] scripts: misc: guix.sh: fix last version detection., Denis 'GNUtoo' Carikli, 2024/04/19
- [PATCH v1 04/14] build instructions: Mention exact package names for debootstrap., Denis 'GNUtoo' Carikli, 2024/04/19
- [PATCH v1 05/14] build instructions: debootstrap: Add Guix., Denis 'GNUtoo' Carikli, 2024/04/19
- [PATCH v1 09/14] scripts: misc: guix.sh: prevent OOM., Denis 'GNUtoo' Carikli, 2024/04/19
- [PATCH v1 03/14] docs/install: Don't officially support T60 with ATI GPUs., Denis 'GNUtoo' Carikli, 2024/04/19
- [PATCH v1 08/14] scripts: misc: guix.sh: make it pass shellcheck., Denis 'GNUtoo' Carikli, 2024/04/19
- [PATCH v1 11/14] gitignore: don't ignore .scm files., Denis 'GNUtoo' Carikli, 2024/04/19
- [PATCH v1 10/14] gitignore: sort rules., Denis 'GNUtoo' Carikli, 2024/04/19
- [PATCH v1 13/14] Makefile.am: Document commands from site/docs/build/index.md.,
Denis 'GNUtoo' Carikli <=
- [PATCH v1 14/14] Build bucts and patched flashrom for I945 ThinkPads with Guix., Denis 'GNUtoo' Carikli, 2024/04/19
- [PATCH v1 12/14] Add topdir ./configure., Denis 'GNUtoo' Carikli, 2024/04/19
- Re: Guix integration and various other patches., Leah Rowe, 2024/04/19
- Re: Guix integration and various other patches., Adrien 'neox' Bourmault, 2024/04/20
- Re: Guix integration and various other patches., Adrien 'neox' Bourmault, 2024/04/20
- Re: [PATCH v1 04/14] build instructions: Mention exact package names for debootstrap., Adrien 'neox' Bourmault, 2024/04/29
- Re: [PATCH v1 05/14] build instructions: debootstrap: Add Guix., Adrien 'neox' Bourmault, 2024/04/29