mirror of
https://github.com/hercules-ci/flake-parts.git
synced 2024-12-14 11:47:31 +00:00
Document technical reason for requiring devShell
This commit is contained in:
parent
e5d5866b1d
commit
0cf2ff3e94
1 changed files with 4 additions and 0 deletions
|
@ -36,6 +36,10 @@ in
|
|||
options = {
|
||||
devShell = mkOption {
|
||||
type = types.package;
|
||||
# We don't have a way to unset devShell in the flake without computing
|
||||
# the root of each allSystems module, so to improve laziness, the best
|
||||
# choice seems to be to require a devShell and give the opportunity
|
||||
# to unset it manually.
|
||||
default = throw "The default devShell was not configured for system ${system}. Please set it, or if you don't want to use the devShell attribute, set flake.devShell = lib.mkForce {};";
|
||||
description = ''
|
||||
A derivation that nix develop bases its environment on.
|
||||
|
|
Loading…
Reference in a new issue