From 90f6ea1fc834eeb6d3ccde7539b1f9ce0830e273 Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Mon, 13 Dec 2021 14:51:42 +0100 Subject: [PATCH] [preservefiles] polish the documentation --- src/modules/preservefiles/preservefiles.conf | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/src/modules/preservefiles/preservefiles.conf b/src/modules/preservefiles/preservefiles.conf index 1c23a93de..2853ac037 100644 --- a/src/modules/preservefiles/preservefiles.conf +++ b/src/modules/preservefiles/preservefiles.conf @@ -11,8 +11,9 @@ # is true, then these items are ignored (since the destination is the same # as the source). # - a map with a *dest* key. The *dest* value is a path interpreted in the -# target system (if dontChroot is true, in the host system). Relative paths -# are not recommended. There are three possible other keys in the map: +# target system (if the global *dontChroot* is true, then the host is the +# target as well). Relative paths are not recommended. There are three +# possible other keys in the map: # - *from*, which must have one of the values, below; it is used to # preserve files whose pathname is known to Calamares internally. # - *src*, to refer to a path interpreted in the host system. Relative @@ -23,17 +24,23 @@ # by owner). If set, the file's ownership and permissions are set to # those values within the target system; if not set, no permissions # are changed. -# Only one of the two source keys (either *from* or *src*) may be set. +# Exactly one of the two source keys (either *from* or *src*) must be set. # -# The target filename is modified as follows: -# - `@@ROOT@@` is replaced by the path to the target root (may be /) +# The target path (*dest*) is modified as follows: +# - `@@ROOT@@` is replaced by the path to the target root (may be /). +# There is never any reason to use this, since the *dest* is already +# interpreted in the target system. # - `@@USER@@` is replaced by the username entered by on the user # page (may be empty, for instance if no user page is enabled) # # Special values for the key *from* are: # - *log*, for the complete log file (up to the moment the preservefiles # module is run), -# - *config*, for a JSON dump of the contents of global storage +# - *config*, for a JSON dump of the contents of global storage. +# Note that this may contain sensitive information, and should be +# given restrictive permissions. +# +# files: - from: log dest: /var/log/Calamares.log