Differential D32477 Diff 97031 usr.sbin/config/config.5

Changeset View

Standalone View

usr.sbin/config/config.5

	Show All 17 Lines
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)			.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd February 9, 2020			.Dd October 17, 2021
	.Dt CONFIG 5			.Dt CONFIG 5
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm config			.Nm config
	.Nd kernel configuration file format			.Nd kernel configuration file format
	.Sh DESCRIPTION			.Sh DESCRIPTION
	A kernel configuration file specifies the configuration of a			A kernel configuration file specifies the configuration of a
	.Fx			.Fx
	▲ Show 20 Lines • Show All 91 Lines • ▼ Show 20 Lines
	over both of these.			over both of these.
	.Pp			.Pp
	.Va loader_env.disabled=1			.Va loader_env.disabled=1
	may be specified in the static environment to disable the			may be specified in the static environment to disable the
	.Xr loader 8			.Xr loader 8
	environment.			environment.
	Disabling the			Disabling the
	.Xr loader 8			.Xr loader 8
	should be done with caution and due consideration for whether or not it supplies			environment should be done with caution and due consideration for whether or not
	environment variables needed for properly booting the system.			it supplies environment variables needed for properly booting the system.
	.Pp			.Pp
	.Va static_env.disabled=1			.Va static_env.disabled=1
	may be specified in the			may be specified in the
	.Xr loader 8			.Xr loader 8
	environment to disable use of the static environment.			environment to disable use of the static environment.
	This option has no effect if specified in any environment after the			This option has no effect if specified in any environment after the
	.Xr loader 8			.Xr loader 8
	environment is processed.			environment is processed.
	▲ Show 20 Lines • Show All 59 Lines • ▼ Show 20 Lines
	and hints in the environment prepared for the kernel by			and hints in the environment prepared for the kernel by
	.Xr loader 8			.Xr loader 8
	takes precedence over hints in the compiled-in environment.			takes precedence over hints in the compiled-in environment.
	.Pp			.Pp
	Once the dynamic environment becomes available, all compiled-in hints will be			Once the dynamic environment becomes available, all compiled-in hints will be
	added to the dynamic environment if they do not already have an override in			added to the dynamic environment if they do not already have an override in
	the dynamic environment.			the dynamic environment.
	The dynamic environment will then be used for all searches of hints.			The dynamic environment will then be used for all searches of hints.
				.Pp
				.Va loader_hints.disabled=1
				may be specified in the compiled-in environment to disable use of hints from
				the
				.Xr loader 8
				environment.
				Disabling hints from the
				.Xr loader 8
				environment should be done with caution and due consideration for whether or not
				it supplies hints needed for properly booting the system.
	.Pp			.Pp
	.Va static_hints.disabled=1			.Va static_hints.disabled=1
	may be specified in either a compiled-in environment or the			may be specified in either a compiled-in environment or the
	.Xr loader 8			.Xr loader 8
	environment to disable use of these hints files.			environment to disable use of these hints files.
	This option has no effect if specified in any environment after the			This option has no effect if specified in any environment after the
	.Xr loader 8			.Xr loader 8
	environment is processed.			environment is processed.
	.Pp			.Pp
	The file			The file
	.Ar filename			.Ar filename
	must conform to the syntax specified by			must conform to the syntax specified by
	.Xr device.hints 5 .			.Xr device.hints 5 .
	Multiple hints lines are allowed.			Multiple hints lines are allowed.
	The resulting hints will be the files concatenated in reverse order of			The resulting hints will be the files concatenated in reverse order of
	appearance so that hints in later files properly override hints in earlier			appearance so that hints in later files properly override hints in earlier
				pauamma_gundo.comUnsubmitted Not Done Inline Actions Is this saying that a "foo=bar" hint will keep any "foo=quux" in an earlier file (and thus seen later because of the reversal) from being processed? pauamma_gundo.com: Is this saying that a "foo=bar" hint will keep any "foo=quux" in an earlier file (and thus seen…
				kevansAuthorUnsubmitted Done Inline Actions Right, because the kernel processes assignments and the first one it encounters for the name `foo` wins, so this statement tries to map how we get the kernel's expected semantics from what is actually written in the configuration. It's mostly an important detail because the reversed order is what you'll see if you dump hints from the kernel binary or observe the generated file. kevans: Right, because the kernel processes assignments and the first one it encounters for the name…
	files.			files.
	.\" -------- IDENT --------			.\" -------- IDENT --------
	.Pp			.Pp
	.It Ic ident Ar name			.It Ic ident Ar name
	Set the kernel name to			Set the kernel name to
	.Ar name .			.Ar name .
	At least one			At least one
	.Ic ident			.Ic ident
	▲ Show 20 Lines • Show All 216 Lines • Show Last 20 Lines