summaryrefslogtreecommitdiff
path: root/modules/system/default.nix
diff options
context:
space:
mode:
authorEmily <vcs@emily.moe>2023-06-22 12:21:32 +0100
committerEmily <vcs@emily.moe>2023-06-24 10:48:55 +0100
commite65131e69cab1b18fb49b572b983a18720502e1b (patch)
tree8bfb50580aad1bc01db494a138ac0855bfc518b3 /modules/system/default.nix
parentefe314cdbabaf5cd210d9c658b4ad540437b7ee5 (diff)
treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]; thanks to @pennae for writing this tool! It automatically checks that the resulting documentation doesn't change, although my fork loosens this a little to ignore some irrelevant whitespace and typographical differences. As of this commit there is no DocBook remaining in the options documentation. You can play along at home if you want to reproduce this commit: $ NIX_PATH=nixpkgs=flake:nixpkgs/c1bca7fe84c646cfd4ebf3482c0e6317a0b13f22 \ nix shell nixpkgs#coreutils \ -c find . -name '*.nix' \ -exec nix run github:emilazy/nix-doc-munge/0a7190f600027bf7baf6cb7139e4d69ac2f51062 \ {} + [my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge
Diffstat (limited to 'modules/system/default.nix')
-rw-r--r--modules/system/default.nix10
1 files changed, 5 insertions, 5 deletions
diff --git a/modules/system/default.nix b/modules/system/default.nix
index 629760c..58369a8 100644
--- a/modules/system/default.nix
+++ b/modules/system/default.nix
@@ -22,7 +22,7 @@ in
internal = true;
type = types.attrsOf types.unspecified;
default = {};
- description = ''
+ description = lib.mdDoc ''
Attribute set of derivation used to setup the system.
'';
};
@@ -30,7 +30,7 @@ in
system.path = mkOption {
internal = true;
type = types.package;
- description = ''
+ description = lib.mdDoc ''
The packages you want in the system environment.
'';
};
@@ -38,7 +38,7 @@ in
system.profile = mkOption {
type = types.path;
default = "/nix/var/nix/profiles/system";
- description = ''
+ description = lib.mdDoc ''
Profile to use for the system.
'';
};
@@ -48,7 +48,7 @@ in
internal = true;
default = [];
example = [ { assertion = false; message = "you can't enable this for that reason"; } ];
- description = ''
+ description = lib.mdDoc ''
This option allows modules to express conditions that must
hold for the evaluation of the system configuration to
succeed, along with associated error messages for the user.
@@ -60,7 +60,7 @@ in
default = [];
type = types.listOf types.str;
example = [ "The `foo' service is deprecated and will go away soon!" ];
- description = ''
+ description = lib.mdDoc ''
This option allows modules to show warnings to users during
the evaluation of the system configuration.
'';