networking.fqdnOrHostName: Elaborate and format the descriptions

This commit is contained in:
Robert Hensing 2022-10-15 11:56:42 +02:00
parent 1ab9d1beb1
commit 18e3f431e1

View File

@ -473,9 +473,12 @@ in
defaultText = literalExpression ''"''${networking.hostName}.''${networking.domain}"'';
description = lib.mdDoc ''
The fully qualified domain name (FQDN) of this host. It is the result
of combining networking.hostName and networking.domain. Using this
of combining `networking.hostName` and `networking.domain.` Using this
option will result in an evaluation error if the hostname is empty or
no domain is specified.
Modules that accept a mere `networing.hostName` but prefer a fully qualified
domain name may use `networking.fqdnOrHostName` instead.
'';
};
@ -491,7 +494,8 @@ in
it does not exists.
This is a convenience option for modules to read instead of `fqdn` when
a mere `hostName` is also an acceptable value.
a mere `hostName` is also an acceptable value; this option does not
throw an error when `domain` is unset.
'';
};