add examples to luks-options

This commit is contained in:
Felix Bühler 2023-04-18 23:19:53 +02:00 committed by GitHub
parent 591b53f72d
commit 73aa16c175
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -14,11 +14,13 @@
type = lib.types.nullOr optionTypes.absolute-pathname; type = lib.types.nullOr optionTypes.absolute-pathname;
default = null; default = null;
description = "Path to the key for encryption"; description = "Path to the key for encryption";
example = "/tmp/disk.key";
}; };
extraFormatArgs = lib.mkOption { extraFormatArgs = lib.mkOption {
type = lib.types.listOf lib.types.str; type = lib.types.listOf lib.types.str;
default = [ ]; default = [ ];
description = "Extra arguments to pass to `cryptsetup luksFormat` when formatting"; description = "Extra arguments to pass to `cryptsetup luksFormat` when formatting";
example = [ "--pbkdf argon2id" ];
}; };
extraOpenArgs = lib.mkOption { extraOpenArgs = lib.mkOption {
type = lib.types.listOf lib.types.str; type = lib.types.listOf lib.types.str;