diff --git a/settings.conf b/settings.conf index 938817ef1..b12e379d5 100644 --- a/settings.conf +++ b/settings.conf @@ -7,8 +7,20 @@ # path to a directory or the keyword "local". # # "local" means: -# - modules in $LIBDIR/calamares/moduleswith +# - modules in $LIBDIR/calamares/modules, with # - settings in SHARE/calamares/modules or /etc/calamares/modules. +# In debug-mode (e.g. calamares -d) "local" also adds some paths +# that make sense from inside the build-directory, so that you +# can build-and-run with the latest modules immediately. +# +# Strings other than "local" are taken as paths and interpreted +# relative to wherever Calamares is started. It is therefore **strongly** +# recommended to use only absolute paths here. This is mostly useful +# if your distro has forks of standard Calamares modules, but also +# uses some form of upstream packaging which might overwrite those +# forked modules -- then you can keep modules somewhere outside of +# the "regular" module tree. +# # # YAML: list of strings. modules-search: [ local ] @@ -157,8 +169,8 @@ dont-chroot: false # If this is set to true, the "Cancel" button will be disabled entirely. # The button is also hidden from view. # -# This can be useful if when e.g. Calamares is used as a post-install -# configuration tool and you require the user to go through all the +# This can be useful if when e.g. Calamares is used as a post-install +# configuration tool and you require the user to go through all the # configuration steps. # # Default is false, but Calamares will complain if this is not explicitly set.