From 22fc59bb2491af5df148e5239f845b5ac62226c8 Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Mon, 9 Dec 2024 08:10:04 -0500 Subject: [PATCH] filesystem: Doc etc.transient I noticed this was missing. Signed-off-by: Colin Walters --- docs/src/filesystem.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/src/filesystem.md b/docs/src/filesystem.md index 756a5b74..dd15d381 100644 --- a/docs/src/filesystem.md +++ b/docs/src/filesystem.md @@ -70,7 +70,8 @@ in derived builds. ## `/etc` The `/etc` directory contains mutable persistent state by default; however, -it is suppported to enable the [`etc.transient` config option](https://ostreedev.github.io/ostree/man/ostree-prepare-root.html). +it is suppported to enable the [`etc.transient` config option](https://ostreedev.github.io/ostree/man/ostree-prepare-root.html), +see below as well. When in persistent mode, it inherits the OSTree semantics of [performing a 3-way merge](https://ostreedev.github.io/ostree/atomic-upgrades/#assembling-a-new-deployment-directory) across upgrades. In a nutshell: @@ -190,6 +191,24 @@ write (transiently, i.e. until the next reboot) to all top-level directories, including `/usr` and `/opt`, with symlinks to `/var` for content that should persist. +This can be combined with `etc.transient` as well (below). + +## Enabling transient etc + +The default (per above) is to have `/etc` persist. If however you do +not need to use it for any per-machine state, then enabling a transient +`/etc` is a great way to reduce the amount of possible state drift. Set +the + +```toml +[etc] +transient = true +``` + +option in `prepare-root.conf`. + +This can be combined with `root.transient` as well (above). + ## Enabling state overlays This feature enables a writable overlay on top of `/opt` (or really, any