1b23520f20
In spite of there being considerable documentation sometimes in the config file, we go with CC0 because we don't want the notion of 'derived work' of a config file. The example `settings.conf` is also CC0. Add some docs to it while we're at it.
53 lines
1.9 KiB
Plaintext
53 lines
1.9 KiB
Plaintext
# SPDX-FileCopyrightText: no
|
|
# SPDX-License-Identifier: CC0-1.0
|
|
#
|
|
# Module that resizes a single FS to fill the entire (rest) of
|
|
# a device. This is used in OEM situations where an image is
|
|
# flashed onto an SD card (or similar) and used to boot a device,
|
|
# after which the FS should expand to fill the SD card.
|
|
#
|
|
# Example: a distro produces a 6GiB large image that is
|
|
# written to an 8GiB SD card; the FS should expand to take
|
|
# advantage of the unused 2GiB. The FS should expand much
|
|
# more if the same image is written to a 16GiB card.
|
|
---
|
|
|
|
# Which FS needs to be grown? Choose one way to identify it:
|
|
# - *fs* names a mount point which should already be mounted
|
|
# in the system.
|
|
# - *dev* names a device
|
|
fs: /
|
|
# dev: /dev/mmcblk0p1
|
|
|
|
# How much of the total remaining space should the FS use?
|
|
# The only sensible amount is "all of it". The value is
|
|
# in percent, so set it to 100. Perhaps a fixed size is
|
|
# needed (that would be weird though, since you don't know
|
|
# how big the card is), use MiB as suffix in that case.
|
|
# If missing, then it's assumed to be 0, and no resizing
|
|
# will happen.
|
|
#
|
|
# Percentages apply to **available space**.
|
|
size: 100%
|
|
|
|
# Resizing might not be worth it, though. Set the minimum
|
|
# that it must grow; if it cannot grow that much, the
|
|
# resizing is skipped. Can be in percentage or absolute
|
|
# size, as above. If missing, then it's assumed to be 0,
|
|
# which means resizing is always worthwhile.
|
|
#
|
|
# If *atleast* is not zero, then the setting *required*,
|
|
# below, becomes relevant.
|
|
#
|
|
# Percentages apply to **total device size**.
|
|
#atleast: 1000MiB
|
|
|
|
# When *atleast* is not zero, then the resize may be
|
|
# recommended (the default) or **required**. If the
|
|
# resize is required and cannot be carried out (because
|
|
# there's not enough space), then that is a fatal
|
|
# error for the installer. By default, resize is only
|
|
# recommended and it is not an error for no resize to be
|
|
# carried out.
|
|
required: false
|