napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[unpackfs] Expand on the documentation

Browse Source
This commit is contained in:
Adriaan de Groot 2019-10-11 16:32:39 +02:00
parent 371ae598a0
commit fe1ddb8ead
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/modules/unpackfs/unpackfs.conf
View File

@ -11,14 +11,14 @@
--- ---
# Each list item is unpacked, in order, to the target system. # Each list item is unpacked, in order, to the target system.
# #
# Each list item has the following attributes: # Each list item has the following **mandatory** attributes:
# source: path relative to the live / intstalling system to the image # - *source* path relative to the live / intstalling system to the image
# sourcefs: the type of the source files; valid entries are # - *sourcefs* the type of the source files; valid entries are
# - *ext4* (copies the filesystem contents) # - `ext4` (copies the filesystem contents)
# - *squashfs* (unsquashes) # - `squashfs` (unsquashes)
# - *file* (copies a file or directory) # - `file` (copies a file or directory)
# - (may be others if mount supports it) # - (may be others if mount supports it)
# destination: path relative to rootMountPoint (so in the target # - *destination* path relative to rootMountPoint (so in the target
# system) where this filesystem is unpacked. It may be an # system) where this filesystem is unpacked. It may be an
# empty string, which effectively is / (the root) of the target # empty string, which effectively is / (the root) of the target
# system. # system.
@ -26,13 +26,18 @@
# EXAMPLES # EXAMPLES
# #
# Usually you list a filesystem image to unpack; you can use # Usually you list a filesystem image to unpack; you can use
# squashfs or an ext4 image. # squashfs or an ext4 image. An empty destination is equivalent to "/",
# the root of the target system. The destination directory must exist
# in the target system.
# #
# - source: "/path/to/filesystem.sqfs" # - source: "/path/to/filesystem.sqfs"
# sourcefs: "squashfs" # sourcefs: "squashfs"
# destination: "" # destination: ""
# #
# Multiple entries are unpacked in-order # Multiple entries are unpacked in-order; if there is more than one
# item then only the first must exist beforehand -- it's ok to
# create directories with one unsquash and then to use those
# directories as a target from a second unsquash.
# #
# - source: "/path/to/another/filesystem.img" # - source: "/path/to/another/filesystem.img"
# sourcefs: "ext4" # sourcefs: "ext4"