diff --git a/README.md b/README.md index 85d8db602..80a6c3eca 100644 --- a/README.md +++ b/README.md @@ -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 } ]; }; diff --git a/nix-darwin/default.nix b/nix-darwin/default.nix index f400c9ce2..8d354a1d5 100644 --- a/nix-darwin/default.nix +++ b/nix-darwin/default.nix @@ -63,8 +63,10 @@ in extraSpecialArgs = mkOption { type = types.attrs; default = { }; + example = literalExpression "{ inherit emacs-overlay; }"; description = '' - Extra specialArgs passed to Home Manager. + Extra specialArgs passed to Home Manager. This + option can be used to pass additional arguments to all modules. ''; }; diff --git a/nixos/default.nix b/nixos/default.nix index e971cdc8c..e8225d984 100644 --- a/nixos/default.nix +++ b/nixos/default.nix @@ -74,8 +74,10 @@ in { extraSpecialArgs = mkOption { type = types.attrs; default = { }; + example = literalExpression "{ inherit emacs-overlay; }"; description = '' - Extra specialArgs passed to Home Manager. + Extra specialArgs passed to Home Manager. This + option can be used to pass additional arguments to all modules. ''; };