From 1a42ba1e73d71867cacc55938d8c43666f349219 Mon Sep 17 00:00:00 2001
From: Guillaume Knispel <gknispel@avencall.com>
Date: Fri, 1 Feb 2013 17:34:07 +0100
Subject: document environment_example

---
 environment_example | 30 ++++++++++++++++++++++++++----
 1 file changed, 26 insertions(+), 4 deletions(-)

diff --git a/environment_example b/environment_example
index e917593..143754a 100644
--- a/environment_example
+++ b/environment_example
@@ -1,7 +1,29 @@
-export KSRC=/usr/src/linux-source-2.6.32
-export KERNEL_SOURCE_ROOT=$KSRC
-export DAHDI_SYMVERS=/usr/src/modules/dahdi-linux/drivers/dahdi/Module.symvers
-export DAHDI_INCLUDE=/usr/src/modules/dahdi-linux/include
+# To build properly, you must have your target dahdi-linux tree with complete
+# build results in it.
+# You can build it in its directory with the following commands mimicking
+# a Debian build under Squeeze:
+#   make dist-clean
+#   dh_clean
+#   fakeroot /usr/bin/make -f debian/rules kdist_clean kdist_config binary-modules
+DAHDI_LINUX=$HOME/dahdi-linux
+
+# ICP_ROOT used to need to be at root because of a fucked-up build-sys
+# (we modified it to be somehow less fucked-up, but I'm not sure everything
+#  is correct)
 export ICP_ROOT=/EP805XX
+
+# VP-API from Legerity^W Zarlink^W Microsemi
+# TODO: update VP-API
 export VP_API=/home/xilun/hard/zarlink/Le71SDKAPIL_P2.17.0
+
+# KSRC: usual target Linux source tree
+export KSRC=/usr/src/linux-source-2.6.32
+
+
+##################################################
+# You should not have to touch anything down there
+#
+export KERNEL_SOURCE_ROOT=$KSRC
+export DAHDI_SYMVERS=$DAHDI_LINUX/drivers/dahdi/Module.symvers
+export DAHDI_INCLUDE=$DAHDI_LINUX/include
 export XIVO_AUDIO=1
-- 
cgit v1.2.3