Skip to content

Commit 6696eb3

Browse files
committed
filesystem: Doc etc.transient
I noticed this was missing. Signed-off-by: Colin Walters <[email protected]>
1 parent aebb4ad commit 6696eb3

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

docs/src/filesystem.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@ in derived builds.
7070
## `/etc`
7171

7272
The `/etc` directory contains mutable persistent state by default; however,
73-
it is suppported to enable the [`etc.transient` config option](https://ostreedev.github.io/ostree/man/ostree-prepare-root.html).
73+
it is suppported to enable the [`etc.transient` config option](https://ostreedev.github.io/ostree/man/ostree-prepare-root.html),
74+
see below as well.
7475

7576
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)
7677
across upgrades. In a nutshell:
@@ -190,6 +191,24 @@ write (transiently, i.e. until the next reboot) to all top-level directories,
190191
including `/usr` and `/opt`, with symlinks to `/var` for content that should
191192
persist.
192193

194+
This can be combined with `etc.transient` as well (below).
195+
196+
## Enabling transient etc
197+
198+
The default (per above) is to have `/etc` persist. If however you do
199+
not need to use it for any per-machine state, then enabling a transient
200+
`/etc` is a great way to reduce the amount of possible state drift. Set
201+
the
202+
203+
```toml
204+
[etc]
205+
transient = true
206+
```
207+
208+
option in `prepare-root.conf`.
209+
210+
This can be combined with `root.transient` as well (above).
211+
193212
## Enabling state overlays
194213

195214
This feature enables a writable overlay on top of `/opt` (or really, any

0 commit comments

Comments
 (0)