From 834cc5d5fa42cc6fd2825696370b9cb5572a134c Mon Sep 17 00:00:00 2001 From: Linus Heckemann Date: Thu, 17 Dec 2020 22:59:49 +0100 Subject: [PATCH] nixos/initrd: docbookise "compressor" description --- nixos/modules/system/boot/stage-1.nix | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/nixos/modules/system/boot/stage-1.nix b/nixos/modules/system/boot/stage-1.nix index 3af80ed20cc..86bfde6349c 100644 --- a/nixos/modules/system/boot/stage-1.nix +++ b/nixos/modules/system/boot/stage-1.nix @@ -518,9 +518,11 @@ in description = '' The compressor to use on the initrd image. May be any of: - - A string representing a command available in stdenv, e.g. "xz"; - - A function which, given the nixpkgs package set, returns the path to a compressor tool, e.g. pkgs: "''${pkgs.pigz}/bin/pigz" - - (not recommended, because it does not work when cross-compiling) the full path to a compressor tool, e.g. "''${pkgs.pigz}/bin/pigz" + + The name of one of the predefined compressors, see pkgs/build-support/kernel/initrd-compressor-meta.nix for the definitions. + A function which, given the nixpkgs package set, returns the path to a compressor tool, e.g. pkgs: "''${pkgs.pigz}/bin/pigz" + (not recommended, because it does not work when cross-compiling) the full path to a compressor tool, e.g. "''${pkgs.pigz}/bin/pigz" + The given program should read data from stdin and write it to stdout compressed. '';