summaryrefslogtreecommitdiff
path: root/manpages
diff options
context:
space:
mode:
authorLyndon Brown <jnqnfe@gmail.com>2020-03-17 04:27:25 +0000
committerLuca Boccassi <bluca@debian.org>2020-03-20 17:25:09 +0000
commit35e622651d51112394bb0d2bb79ef08e122b8c6d (patch)
tree001a61e17b183b646459257d5c5951abb37296a7 /manpages
parenta56fe5e40b1ffd55394b016466a12db0b3d01be2 (diff)
downloadvyos-live-build-35e622651d51112394bb0d2bb79ef08e122b8c6d.tar.gz
vyos-live-build-35e622651d51112394bb0d2bb79ef08e122b8c6d.zip
manpages: clarify `lb config` notes
Diffstat (limited to 'manpages')
-rw-r--r--manpages/en/lb_config.12
1 files changed, 1 insertions, 1 deletions
diff --git a/manpages/en/lb_config.1 b/manpages/en/lb_config.1
index d7a356147..64a905dfd 100644
--- a/manpages/en/lb_config.1
+++ b/manpages/en/lb_config.1
@@ -243,7 +243,7 @@
.PP
\fBlb config\fR populates the configuration directory for live\-build. This directory is named 'config' and is created in the current directory where \fBlb config\fR was executed.
.PP
-Note: \fBlb config\fR tries to be smart and sets defaults for some options depending on the setting of other options. This means that when generating a new configuration, you should call \fBlb config\fR only once with all options specified. Calling it several times with only a subset of the options each time can result in non working configurations. This is also caused by the fact that \fBlb config\fR called with one option only changes that option, and leaves everything else as is unless it is not defined. However, \fBlb config\fR does warn about known impossible or likely impossible combinations that would lead to non working Debian Live. If unsure, remove config/{binary,build,bootstrap,chroot,common,source} and call \fBlb config\fR again.
+Note: \fBlb config\fR tries to be smart and sets defaults for some options depending upon the settings of others. However, this only typically happens when no existing saved config exists, because values are only automatically set when not already defined (and running \fBlb config\fR involves loading any existing config). This means that when generating a new configuration, you should typically first ensure that any existing saved config files are removed (by deletion of \fBconfig/{binary,build,bootstrap,chroot,common,source}\fR), before then calling \fBlb config\fR just once with \fBall\fR necessary options specified. Calling it when an existing saved config exists risks ending up with a non\-working configuration, depending on the options changed, since in doing so other options may end up with different values than they otherwise might have had had automatic setting of them not been blocked by an existing saved value. In some cases invalid combinations will be noticed and reported as an error or warning, but this is not always the case and should not be relied upon.
.SH OPTIONS
In addition to its specific options \fBlb config\fR understands all generic live\-build options. See \fIlive\-build\fR(7) for a complete list of all generic live\-build options.