From 23b53869254866ab955938539fa8d4f463da49bd Mon Sep 17 00:00:00 2001
From: nbd <nbd@3c298f89-4303-0410-b956-a3cf2f4a3e73>
Date: Fri, 28 Dec 2007 17:03:48 +0000
Subject: document Build/InstallDev

git-svn-id: svn://svn.openwrt.org/openwrt/trunk@9993 3c298f89-4303-0410-b956-a3cf2f4a3e73
---
 docs/build.tex | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'docs/build.tex')

diff --git a/docs/build.tex b/docs/build.tex
index c45b90504..730451ede 100644
--- a/docs/build.tex
+++ b/docs/build.tex
@@ -342,6 +342,19 @@ directly as the Nth argument to \texttt{BuildPackage}.
 	   Contains all environment variables that are passed to the make command
    \end{itemize}
 
+\textbf{\texttt{Build/InstallDev} (optional):} \\
+	If your package provides a library that needs to be made available to other packages,
+	you can use the \texttt{Build/InstallDev} template to copy it into the staging directory
+	which is used to collect all files that other packages might depend on at build time.
+	When it is called by the build system, two parameters are passed to it. \texttt{\$(1)} points to
+	the regular staging dir, typically \texttt{staging\_dir/\textit{ARCH}}, while \texttt{\$(2)} points
+	to \texttt{staging\_dir/host}. The host staging dir is only used for binaries, which are
+	to be executed or linked against on the host and its \texttt{bin/} subdirectory is included
+	in the \texttt{PATH} which is passed down to the build system processes.
+	Please use \texttt{\$(1)} and \texttt{\$(2)} here instead of the build system variables
+	\texttt{\$(STAGING\_DIR)} and \texttt{\$(STAGING\_DIR\_HOST)}, because the build system behavior
+	when staging libraries might change in the future to include automatic uninstallation.
+
 \textbf{\texttt{Package/\textit{<name>}/install}:} \\
    A set of commands to copy files out of the compiled source and into the ipkg
    which is represented by the \texttt{\$(1)} directory. Note that there are currently
-- 
cgit v1.2.3

