From 2304371f05643c8de0f990ac5afe86f9c2b3fef4 Mon Sep 17 00:00:00 2001 From: Joerg Behrmann Date: Thu, 28 Sep 2023 16:23:33 +0200 Subject: [PATCH] man: add a table which script receives what environment variable --- mkosi/resources/mkosi.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/mkosi/resources/mkosi.md b/mkosi/resources/mkosi.md index 108f2ddcb..38416b356 100644 --- a/mkosi/resources/mkosi.md +++ b/mkosi/resources/mkosi.md @@ -1383,6 +1383,28 @@ Scripts executed by mkosi receive the following environment variables: with `setpriv` to run commands as the user that invoked mkosi (e.g. `setpriv --reuid=$MKOSI_UID --regid=$MKOSI_GID --clear-groups `) +Consult this table for which script receives which environment variables: + +| Variable | `mkosi.prepare` | `mkosi.build` | `mkosi.postinst` | `mkosi.finalize` | +|---------------------|-----------------|---------------|------------------|------------------| +| `$CHROOT_SCRIPT` | X | X | X | X | +| `$SRCDIR` | X | X | X | X | +| `CHROOT_SRCDIR` | X | X | X | X | +| `$BUILDDIR` | | X | | | +| `CHROOT_BUILDDIR` | | X | | | +| `DESTDIR` | | X | | | +| `CHROOT_DESTDIR` | | X | | | +| `$OUTPUTDIR` | | X | X | X | +| `CHROOT_OUTPUTDIR` | | X | X | X | +| `$BUILDROOT` | X | X | X | X | +| `WITH_DOCS` | X | X | | | +| `WITH_TESTS` | X | X | | | +| `WITH_NETWORK` | X | X | | | +| `SOURCE_DATE_EPOCH` | X | X | X | X | +| `MKOSI_UID` | X | X | X | X | +| `MKOSI_GID` | X | X | X | X | + + Additionally, when a script is executed, a few scripts are made available via `$PATH` to simplify common usecases. -- 2.47.2