summary refs log tree commit diff
path: root/lib/tests/misc.nix
diff options
context:
space:
mode:
authorSilvan Mosberger <silvan.mosberger@tweag.io>2023-07-18 17:20:28 +0200
committerSilvan Mosberger <silvan.mosberger@tweag.io>2023-07-18 17:22:45 +0200
commit581d7c88bea4216fb47c2a98f38af59f2d14485d (patch)
treef954f31b7bac5fb2681c0d19552dab3272303a1b /lib/tests/misc.nix
parent03431f1244a92659cf26a1b6e40de5db00c5e310 (diff)
downloadnixpkgs-581d7c88bea4216fb47c2a98f38af59f2d14485d.tar
nixpkgs-581d7c88bea4216fb47c2a98f38af59f2d14485d.tar.gz
nixpkgs-581d7c88bea4216fb47c2a98f38af59f2d14485d.tar.bz2
nixpkgs-581d7c88bea4216fb47c2a98f38af59f2d14485d.tar.lz
nixpkgs-581d7c88bea4216fb47c2a98f38af59f2d14485d.tar.xz
nixpkgs-581d7c88bea4216fb47c2a98f38af59f2d14485d.tar.zst
nixpkgs-581d7c88bea4216fb47c2a98f38af59f2d14485d.zip
lib/tests: Unify documentation of individual testable files
Diffstat (limited to 'lib/tests/misc.nix')
-rw-r--r--lib/tests/misc.nix18
1 files changed, 15 insertions, 3 deletions
diff --git a/lib/tests/misc.nix b/lib/tests/misc.nix
index 231f19c513e..6dc0d391fb4 100644
--- a/lib/tests/misc.nix
+++ b/lib/tests/misc.nix
@@ -1,6 +1,18 @@
-# to run these tests:
-# nix-instantiate --eval --strict nixpkgs/lib/tests/misc.nix
-# if the resulting list is empty, all tests passed
+/*
+Nix evaluation tests for various lib functions.
+
+Since these tests are implemented with Nix evaluation, error checking is limited to what `builtins.tryEval` can detect, which is `throw`'s and `abort`'s, without error messages.
+If you need to test error messages or more complex evaluations, see ./modules.sh, ./sources.sh or ./filesystem.sh as examples.
+
+To run these tests:
+
+  [nixpkgs]$ nix-instantiate --eval --strict lib/tests/misc.nix
+
+If the resulting list is empty, all tests passed.
+Alternatively, to run all `lib` tests:
+
+  [nixpkgs]$ nix-build lib/tests/release.nix
+*/
 with import ../default.nix;
 
 let