modules/programs: better document the env option

This commit is contained in:
Colin 2024-02-14 11:08:43 +00:00
parent c9e02bfd8a
commit 22ca253ae0

View File

@ -251,7 +251,11 @@ let
env = mkOption { env = mkOption {
type = types.attrsOf types.str; type = types.attrsOf types.str;
default = {}; default = {};
description = "environment variables to set when this program is enabled"; description = ''
environment variables to set when this program is enabled.
env vars set here are intended to propagate everywhere into the user's (or system's) session/services;
they aren't visible just to the program which specified them.
'';
}; };
services = mkOption { services = mkOption {
# see: <repo:nixos/nixpkgs:nixos/lib/utils.nix> # see: <repo:nixos/nixpkgs:nixos/lib/utils.nix>