nixos/plymouth: improving documentation of logo option

This commit is contained in:
aleksana 2024-01-23 22:55:18 +08:00
parent 380761c2f5
commit ec87671bd1

View file

@ -4,7 +4,6 @@ with lib;
let let
inherit (pkgs) nixos-icons;
plymouth = pkgs.plymouth.override { plymouth = pkgs.plymouth.override {
systemd = config.boot.initrd.systemd.package; systemd = config.boot.initrd.systemd.package;
}; };
@ -97,8 +96,8 @@ in
logo = mkOption { logo = mkOption {
type = types.path; type = types.path;
# Dimensions are 48x48 to match GDM logo # Dimensions are 48x48 to match GDM logo
default = "${nixos-icons}/share/icons/hicolor/48x48/apps/nix-snowflake-white.png"; default = "${pkgs.nixos-icons}/share/icons/hicolor/48x48/apps/nix-snowflake-white.png";
defaultText = literalExpression ''"''${nixos-icons}/share/icons/hicolor/48x48/apps/nix-snowflake-white.png"''; defaultText = literalExpression ''"''${pkgs.nixos-icons}/share/icons/hicolor/48x48/apps/nix-snowflake-white.png"'';
example = literalExpression '' example = literalExpression ''
pkgs.fetchurl { pkgs.fetchurl {
url = "https://nixos.org/logo/nixos-hires.png"; url = "https://nixos.org/logo/nixos-hires.png";
@ -107,6 +106,7 @@ in
''; '';
description = lib.mdDoc '' description = lib.mdDoc ''
Logo which is displayed on the splash screen. Logo which is displayed on the splash screen.
Currently supports PNG file format only.
''; '';
}; };