pkgs/test/nixos-functions: Add inline doc

2018-10-25 15:58:11 +02:00 · 2018-10-25 15:58:11 +02:00 · 3783f2d510
parent d82e1528f8
commit 3783f2d510
1 changed files with 11 additions and 0 deletions
--- a/pkgs/test/nixos-functions/default.nix
+++ b/pkgs/test/nixos-functions/default.nix
@ -1,3 +1,14 @@
+/*
+
+This file is a test that makes sure that the `pkgs.nixos` and
+`pkgs.nixosTest` functions work. It's far from a perfect test suite,
+but better than not checking them at all on hydra.
+
+To run this test:
+
+    nixpkgs$ nix-build -A tests.nixos-functions
+
+ */
 { pkgs, lib, stdenv, ... }:

 lib.optionalAttrs stdenv.hostPlatform.isLinux (