From 3783f2d5105412cec727816b385631047b2af01b Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Thu, 25 Oct 2018 15:58:11 +0200
Subject: pkgs/test/nixos-functions: Add inline doc

---
 pkgs/test/nixos-functions/default.nix | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'pkgs/test')

diff --git a/pkgs/test/nixos-functions/default.nix b/pkgs/test/nixos-functions/default.nix
index a53157066bb..c8f7122006f 100644
--- 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 (
-- 
cgit v1.2.3