modules/nixpkgs: warn about changing defaults

If end-users change the nixpkgs revision to something other than our
default, they can run into issues not picked up by our test suite.
This commit is contained in:
Matt Sturgeon 2025-01-19 13:10:34 +00:00
parent 3a22953bea
commit 82415eaa5d
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
2 changed files with 8 additions and 3 deletions

View file

@ -50,9 +50,8 @@ in
so user-provided configuration can override it without using `lib`. so user-provided configuration can override it without using `lib`.
E.g. Nixvim's home-manager module can re-use the `pkgs` instance from the "host" modules. E.g. Nixvim's home-manager module can re-use the `pkgs` instance from the "host" modules.
> [!NOTE] > [!CAUTION]
> Using a distinct version of Nixpkgs with Nixvim may be an unexpected source of problems. > Changing this option can lead to issues that may be difficult to debug.
> Use this option with care.
''; '';
}; };
@ -198,6 +197,9 @@ in
The path to import Nixpkgs from. The path to import Nixpkgs from.
Ignored when `nixpkgs.pkgs` is set. Ignored when `nixpkgs.pkgs` is set.
> [!CAUTION]
> Changing this option can lead to issues that may be difficult to debug.
''; '';
}; };
}; };

View file

@ -40,6 +40,9 @@ in
description = '' description = ''
Whether Nixvim should use the ${config.meta.wrapper.name} configuration's `pkgs`, Whether Nixvim should use the ${config.meta.wrapper.name} configuration's `pkgs`,
instead of constructing its own instance. instead of constructing its own instance.
> [!CAUTION]
> Changing this option can lead to issues that may be difficult to debug.
''; '';
}; };
}; };