From 2d2c6f1fbdb6b464c3491df495716acce1d79ab9 Mon Sep 17 00:00:00 2001 From: Denis 'GNUtoo' Carikli Date: Fri, 6 Sep 2024 20:15:31 +0200 Subject: [PATCH] packages: Add extremely basic documentation for the various tasks. Signed-off-by: Denis 'GNUtoo' Carikli Acked-by: Adrien 'neox' Bourmault --- resources/packages/README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 resources/packages/README.md diff --git a/resources/packages/README.md b/resources/packages/README.md new file mode 100644 index 0000000..34bfe29 --- /dev/null +++ b/resources/packages/README.md @@ -0,0 +1,27 @@ +Common tasks +------------ +boot: Produce some binary that boots and install it in bin/. +clean: Remove all built files. +distclean: Remove all files including build configuration files. +download: Download files for offline building. Sometimes also builds or + download already-built packages when Guix is being used. +module: Build some project in its source tree. +payload: Produce a payload and install it in payload/. +release: Install files in release/ for making a GNU Boot release. +test: Run automatic tests of the package. + +Task specific to descriptors +---------------------------- +build: build the Intel flash descriptors and put them in build/descriptors. + +Task specific to dependencies +----------------------------- +install: install dependencies. See the +website/pages/docs/build/index.md documentation for more details. + +Tasks specific to u-boot +------------------------ +deblob-download: See commit 4744953f7345dd8ccf452c3acbe1597b6a2fef52 + ("u-boot-libre: move to different tasks.") for more details. +deblob-release: See commit 4744953f7345dd8ccf452c3acbe1597b6a2fef52 + ("u-boot-libre: move to different tasks.") for more details.