aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/generate-options.nix
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manual/generate-options.nix')
-rw-r--r--doc/manual/generate-options.nix13
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/manual/generate-options.nix b/doc/manual/generate-options.nix
index 84d90beb6..680b709c8 100644
--- a/doc/manual/generate-options.nix
+++ b/doc/manual/generate-options.nix
@@ -6,20 +6,21 @@ options:
concatStrings (map
(name:
let option = options.${name}; in
- " - `${name}` \n\n"
+ " - [`${name}`](#conf-${name})"
+ + "<p id=\"conf-${name}\"></p>\n\n"
+ concatStrings (map (s: " ${s}\n") (splitLines option.description)) + "\n\n"
+ (if option.documentDefault
then " **Default:** " + (
- if option.value == "" || option.value == []
+ if option.defaultValue == "" || option.defaultValue == []
then "*empty*"
- else if isBool option.value
- then (if option.value then "`true`" else "`false`")
+ else if isBool option.defaultValue
+ then (if option.defaultValue then "`true`" else "`false`")
else
# n.b. a StringMap value type is specified as a string, but
# this shows the value type. The empty stringmap is "null" in
# JSON, but that converts to "{ }" here.
- (if isAttrs option.value then "`\"\"`"
- else "`" + toString option.value + "`")) + "\n\n"
+ (if isAttrs option.defaultValue then "`\"\"`"
+ else "`" + toString option.defaultValue + "`")) + "\n\n"
else " **Default:** *machine-specific*\n")
+ (if option.aliases != []
then " **Deprecated alias:** " + (concatStringsSep ", " (map (s: "`${s}`") option.aliases)) + "\n\n"