docs: improve description of extraSpecialArgs

This commit is contained in:
Lorenzo Manacorda 2021-11-01 17:42:22 +01:00 committed by Robert Helgesson
parent be1ad30503
commit 39c5c7397e
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89
3 changed files with 9 additions and 2 deletions

View file

@ -345,6 +345,9 @@ as follows:
home-manager.useGlobalPkgs = true;
home-manager.useUserPackages = true;
home-manager.users.jdoe = import ./home.nix;
# Optionally, use home-manager.extraSpecialArgs to pass
# arguments to home.nix
}
];
};

View file

@ -63,8 +63,10 @@ in
extraSpecialArgs = mkOption {
type = types.attrs;
default = { };
example = literalExpression "{ inherit emacs-overlay; }";
description = ''
Extra <literal>specialArgs</literal> passed to Home Manager.
Extra <literal>specialArgs</literal> passed to Home Manager. This
option can be used to pass additional arguments to all modules.
'';
};

View file

@ -74,8 +74,10 @@ in {
extraSpecialArgs = mkOption {
type = types.attrs;
default = { };
example = literalExpression "{ inherit emacs-overlay; }";
description = ''
Extra <literal>specialArgs</literal> passed to Home Manager.
Extra <literal>specialArgs</literal> passed to Home Manager. This
option can be used to pass additional arguments to all modules.
'';
};