loader.conf(5): document that loader_conf_files may be clobbered

A future change in lualoader may take some liberties with the
loader_conf_files in the name of efficiency; namely, it may start omitting
it from the loader environment entirely so that it doesn't need to worry
about maintaining any specific value.

This variable has historically been incredibly volatile anyways, as it may
get set to completely different values in any given configuration file to
trigger a load of more files.

Document now that we may not maintain it in the future, but perhaps we'll
reserve the right to change our minds and eventually formally export all of
the loader configuration files that were read using this variable.

MFC after:	3 days
This commit is contained in:
kevans 2020-04-30 02:50:58 +00:00
parent b8ce7e8464
commit 04816a15fb

View File

@ -23,7 +23,7 @@
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.Dd October 6, 2018 .Dd April 29, 2020
.Dt LOADER.CONF 5 .Dt LOADER.CONF 5
.Os .Os
.Sh NAME .Sh NAME
@ -91,6 +91,10 @@ independently.
.It Ar loader_conf_files .It Ar loader_conf_files
Defines additional configuration files to be processed right after the Defines additional configuration files to be processed right after the
present file. present file.
.Ar loader_conf_files
should be treated as write-only.
One cannot depend on any value remaining in the loader environment or carried
over into the kernel environment.
.It Ar kernel .It Ar kernel
Name of the kernel to be loaded. Name of the kernel to be loaded.
If no kernel name is set, no additional If no kernel name is set, no additional