From 735d2a4f665f579aaf64124a1b515756f1f8d083 Mon Sep 17 00:00:00 2001
From: Marc Weber <marco-oweber@gmx.de>
Date: Thu, 17 Jan 2008 11:14:00 +0000
Subject: [PATCH] added small comment on how to use textClosure, also added
 reference to builder-defs.nix

svn path=/nixpkgs/trunk/; revision=10186
---
 pkgs/lib/strings-with-deps.nix | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/pkgs/lib/strings-with-deps.nix b/pkgs/lib/strings-with-deps.nix
index 78cded99ef71..c70c1f2728d4 100644
--- a/pkgs/lib/strings-with-deps.nix
+++ b/pkgs/lib/strings-with-deps.nix
@@ -1,3 +1,18 @@
+/*
+Usage:
+
+  You define you custom builder script by adding all build steps to a list.
+  for example:
+	builder = writeScript "fsg-4.4-builder"
+		(textClosure [doUnpack addInputs preBuild doMake installPhase doForceShare]);
+
+  a step is defined by noDepEntry, FullDepEntry or PackEntry.
+  To ensure that prerequisite are met those are added before the task itself by
+  textClosureDupList. Duplicated items are removed again.
+
+  See trace/nixpkgs/trunk/pkgs/top-level/builder-defs.nix for some predefined build steps
+
+*/
 args: 
 	with args;
 	with lib;