modules-search: [ local ]
# Instances section. This section is optional, and it defines custom instances
-# for modules of any kind. An instance entry has an instance name, a module
+# for modules of any kind. An instance entry has an module name, an instance
# name, and a configuration file name. The primary goal of this mechanism is
# to allow loading multiple instances of the same module, with different
# configuration. If you don't need this, the instances section can safely be
#
# Module name plus instance name makes an instance key, e.g.
# "webview@owncloud", where "webview" is the module name (for the webview
-# viewmodule) and "owncloud" is the instance name, which loads a configuration
-# file named "owncloud.conf" from any of the configuration file paths,
-# including the webview module directory. This instance key can then be
-# referenced in the sequence section.
-#
-# For all modules without a custom instance specification, a default instance
-# is generated automatically by Calamares. Therefore a statement such as
-# "webview" in the sequence section automatically implies an instance key of
-# "webview@webview" even without explicitly defining this instance, and the
-# configuration file for this default instance "<modulename>@<modulename>" is
-# always assumed to be "<modulename>.conf".
+# viewmodule) and "owncloud" is the instance name. In the *sequence*
+# section below, use instance-keys to name instances (instead of just
+# a module name, for modules which have only a single instance).
+#
+# Every module implicitly has an instance with the instance name equal
+# to its module name, e.g. "welcome@welcome". In the *sequence* section,
+# mentioning a module without a full instance key (e.g. "welcome")
+# means that implicit module.
+#
+# An instance must specify its configuration file (e.g. `webview-home.conf`).
+# The implicit instances all have configuration files named `<module>.conf`.
+# This (implict) way matches the source examples, where the welcome
+# module contains an example `welcome.conf`.
#
# For more information on running module instances, run Calamares in debug
# mode and check the Modules page in the Debug information interface.
#
-# A module that is often used with instances is dummyprocess, which will
-# run a single (shell) command. By configuring more than one instance of
-# the module, multiple shell commands can be run during install.
+# A module that is often used with instances is shellprocess, which will
+# run shell commands specified in the configuration file. By configuring
+# more than one instance of the module, multiple shell sessions can be run
+# during install.
#
# YAML: list of maps of string:string key-value pairs.
#instances:
OSDN Git Service
