From: Jörg Behrmann <behrmann@physik.fu-berlin.de>
Date: Wed, 15 May 2024 07:36:01 +0000 (+0200)
Subject: doc: remove "mkosi." prefix from environment variable table
X-Git-Tag: v23.1~42^2~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=952d83225fb8203ccefe5f1191198568c867d116;p=thirdparty%2Fmkosi.git

doc: remove "mkosi." prefix from environment variable table

pandoc has a weird algorithm to define the width of tables in markdown. The
width cannot be specified absolutely, but is made relative to the text width by
how many dashes are in the horizontal line under the header in each
column. This can lead to spurious word breaks even on wide displays where the
whole table would fit. Removing the prefix should somewhat ameliorate the
problem until a better solution is found.
---

diff --git a/mkosi/resources/mkosi.md b/mkosi/resources/mkosi.md
index c22bfeaf2..ca62811fe 100644
--- a/mkosi/resources/mkosi.md
+++ b/mkosi/resources/mkosi.md
@@ -2092,33 +2092,33 @@ Scripts executed by mkosi receive the following environment variables:
 
 Consult this table for which script receives which environment variables:
 
-| Variable            | `mkosi.configure` | `mkosi.sync` | `mkosi.prepare` | `mkosi.build` | `mkosi.postinst` | `mkosi.finalize` | `mkosi.clean` |
-|---------------------|:-----------------:|:------------:|:---------------:|:-------------:|:----------------:|:----------------:|:-------------:|
-| `ARCHITECTURE`      | X                 | X            | X               | X             | X                | X                | X             |
-| `QEMU_ARCHITECTURE` | X                 |              |                 |               |                  |                  |               |
-| `DISTRIBUTION`      | X                 | X            | X               | X             | X                | X                | X             |
-| `RELEASE`           | X                 | X            | X               | X             | X                | X                | X             |
-| `PROFILE`           | X                 | X            | X               | X             | X                | X                | X             |
-| `CACHED`            |                   | X            |                 |               |                  |                  |               |
-| `CHROOT_SCRIPT`     |                   |              | X               | X             | X                | X                |               |
-| `SRCDIR`            | X                 | X            | X               | X             | X                | X                | X             |
-| `CHROOT_SRCDIR`     |                   |              | X               | X             | X                | X                |               |
-| `BUILDDIR`          |                   |              |                 | X             |                  |                  |               |
-| `CHROOT_BUILDDIR`   |                   |              |                 | X             |                  |                  |               |
-| `DESTDIR`           |                   |              |                 | X             |                  |                  |               |
-| `CHROOT_DESTDIR`    |                   |              |                 | X             |                  |                  |               |
-| `OUTPUTDIR`         |                   |              |                 | X             | X                | X                | X             |
-| `CHROOT_OUTPUTDIR`  |                   |              |                 | X             | X                | X                |               |
-| `BUILDROOT`         |                   |              | X               | X             | X                | X                |               |
-| `PACKAGEDIR`        |                   |              | x               | x             | x                | x                |               |
-| `ARTIFACTDIR`       |                   |              | x               | x             | x                | x                |               |
-| `WITH_DOCS`         |                   |              | X               | X             |                  |                  |               |
-| `WITH_TESTS`        |                   |              | X               | X             |                  |                  |               |
-| `WITH_NETWORK`      |                   |              | X               | X             | x                | x                |               |
-| `SOURCE_DATE_EPOCH` |                   |              | X               | X             | X                | X                | X             |
-| `MKOSI_UID`         | X                 | X            | X               | X             | X                | X                | X             |
-| `MKOSI_GID`         | X                 | X            | X               | X             | X                | X                | X             |
-| `MKOSI_CONFIG`      |                   | X            | X               | X             | X                | X                | X             |
+| Variable            | `configure` | `sync` | `prepare` | `build` | `postinst` | `finalize` | `clean` |
+|---------------------|:-----------:|:------:|:---------:|:-------:|:----------:|:----------:|:-------:|
+| `ARCHITECTURE`      | X           | X      | X         | X       | X          | X          | X       |
+| `QEMU_ARCHITECTURE` | X           |        |           |         |            |            |         |
+| `DISTRIBUTION`      | X           | X      | X         | X       | X          | X          | X       |
+| `RELEASE`           | X           | X      | X         | X       | X          | X          | X       |
+| `PROFILE`           | X           | X      | X         | X       | X          | X          | X       |
+| `CACHED`            |             | X      |           |         |            |            |         |
+| `CHROOT_SCRIPT`     |             |        | X         | X       | X          | X          |         |
+| `SRCDIR`            | X           | X      | X         | X       | X          | X          | X       |
+| `CHROOT_SRCDIR`     |             |        | X         | X       | X          | X          |         |
+| `BUILDDIR`          |             |        |           | X       |            |            |         |
+| `CHROOT_BUILDDIR`   |             |        |           | X       |            |            |         |
+| `DESTDIR`           |             |        |           | X       |            |            |         |
+| `CHROOT_DESTDIR`    |             |        |           | X       |            |            |         |
+| `OUTPUTDIR`         |             |        |           | X       | X          | X          | X       |
+| `CHROOT_OUTPUTDIR`  |             |        |           | X       | X          | X          |         |
+| `BUILDROOT`         |             |        | X         | X       | X          | X          |         |
+| `PACKAGEDIR`        |             |        | x         | x       | x          | x          |         |
+| `ARTIFACTDIR`       |             |        | x         | x       | x          | x          |         |
+| `WITH_DOCS`         |             |        | X         | X       |            |            |         |
+| `WITH_TESTS`        |             |        | X         | X       |            |            |         |
+| `WITH_NETWORK`      |             |        | X         | X       | x          | x          |         |
+| `SOURCE_DATE_EPOCH` |             |        | X         | X       | X          | X          | X       |
+| `MKOSI_UID`         | X           | X      | X         | X       | X          | X          | X       |
+| `MKOSI_GID`         | X           | X      | X         | X       | X          | X          | X       |
+| `MKOSI_CONFIG`      |             | X      | X         | X       | X          | X          | X       |
 
 Additionally, when a script is executed, a few scripts are made
 available via `$PATH` to simplify common usecases.