summaryrefslogtreecommitdiff
path: root/nix/README
diff options
context:
space:
mode:
authorPetr Rockai <me@mornfall.net>2014-02-27 23:36:49 +0100
committerPetr Rockai <me@mornfall.net>2014-02-28 11:23:52 +0100
commitb86489843ea1d82430fbf7a9d1e68d9187f6acbe (patch)
tree2de84b2a274ea979b7d87208825dd66cbff04fbd /nix/README
parent421ca4cd143d3d3935567a76dbed1b19d7c397ce (diff)
downloadlvm2-b86489843ea1d82430fbf7a9d1e68d9187f6acbe.tar.gz
NIX: Add a short README (to be expanded).
Diffstat (limited to 'nix/README')
-rw-r--r--nix/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/nix/README b/nix/README
new file mode 100644
index 000000000..bee7a0751
--- /dev/null
+++ b/nix/README
@@ -0,0 +1,13 @@
+This directory contains nix integration for building and testing LVM2 in various
+virtual machine configurations. The *.nix files are written in the nix
+declarative language (see http://nixos.org/nix).
+
+There are two basic use-cases for this integration. First, a hydra instance (see
+http://divine.fi.muni.cz/hydra/project/lvm2 and
+http://divine.fi.muni.cz/~xrockai/lvm-testmatrix.html) builds and tests LVM in
+all the configurations described in default.nix after every push to the git
+repository. Second, any nix-enabled system can very closely reproduce any of
+those test scenarios using the "build.sh" script and an appropriate checkout of
+"nixpkgs" (cf. http://nixos.org/nixpkgs).
+
+(The rest of this document is TODO.)