]> git.ipfire.org Git - thirdparty/mkosi.git/commitdiff
doc: remove "mkosi." prefix from environment variable table
authorJörg Behrmann <behrmann@physik.fu-berlin.de>
Wed, 15 May 2024 07:36:01 +0000 (09:36 +0200)
committerJörg Behrmann <behrmann@physik.fu-berlin.de>
Tue, 28 May 2024 15:04:43 +0000 (17:04 +0200)
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.

mkosi/resources/mkosi.md

index c22bfeaf250d770abe17d599fe1a7f61fa1fec57..ca62811fe88924c5431471d2f3af882bd2dfc21e 100644 (file)
@@ -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.