aboutsummaryrefslogtreecommitdiffstats
path: root/docs/build.tex
diff options
context:
space:
mode:
authorTim Yardley <lst@openwrt.org>2006-11-26 21:28:16 +0000
committerTim Yardley <lst@openwrt.org>2006-11-26 21:28:16 +0000
commitf7730a4bdb91d931ce010a56b07f28f0e174f9f4 (patch)
tree0af2ad630b70e96395084ef711b9ed7cb7cbcc84 /docs/build.tex
parent5b524506f890ad112ddd797607b592d7846d32ee (diff)
downloadupstream-f7730a4bdb91d931ce010a56b07f28f0e174f9f4.tar.gz
upstream-f7730a4bdb91d931ce010a56b07f28f0e174f9f4.tar.bz2
upstream-f7730a4bdb91d931ce010a56b07f28f0e174f9f4.zip
some more build docs
git-svn-id: svn://svn.openwrt.org/openwrt/trunk@5648 3c298f89-4303-0410-b956-a3cf2f4a3e73
Diffstat (limited to 'docs/build.tex')
-rw-r--r--docs/build.tex27
1 files changed, 24 insertions, 3 deletions
diff --git a/docs/build.tex b/docs/build.tex
index e9cdaf382c..1b7f76487d 100644
--- a/docs/build.tex
+++ b/docs/build.tex
@@ -245,7 +245,7 @@ and abstracted to the point where you only need to specify a few variables.
\item \texttt{PKG\_SOURCE} \\
The filename of the original sources
\item \texttt{PKG\_SOURCE\_URL} \\
- Where to download the sources from
+ Where to download the sources from (no trailing slash)
\item \texttt{PKG\_MD5SUM} \\
A checksum to validate the download
\item \texttt{PKG\_CAT} \\
@@ -255,7 +255,9 @@ and abstracted to the point where you only need to specify a few variables.
\end{itemize}
The \texttt{PKG\_*} variables define where to download the package from;
-\texttt{@SF} is a special keyword for downloading packages from sourceforge.
+\texttt{@SF} is a special keyword for downloading packages from sourceforge. There is also
+another keyword of \texttt{@GNU} for grabbing GNU source releases.
+
The md5sum is used to verify the package was downloaded correctly and
\texttt{PKG\_BUILD\_DIR} defines where to find the package after the sources are
uncompressed into \texttt{\$(BUILD\_DIR)}.
@@ -331,7 +333,26 @@ After you've created your \texttt{package/\textit{<name>}/Makefile}, the new pac
will automatically show in the menu the next time you run "make menuconfig" and if selected
will be built automatically the next time "\texttt{make}" is run.
-\subsubsection{Troubleshooting}
+
+\subsection{Conventions}
+
+There are a couple conventions to follow regarding packages:
+
+\begin{itemize}
+ \item \texttt{files}
+ \begin{enumerate}
+ \item configuration files follow the convention \\
+ \texttt{\textit{<name>}.conf}
+ \item init files follow the convention \\
+ \texttt{\textit{<name>}.init}
+ \end{enumerate}
+ \item \texttt{patches}
+ \begin{enumerate}
+ \item patches are numerically prefixed and named related to what they do
+ \end{enumerate}
+\end{itemize}
+
+\subsection{Troubleshooting}
If you find your package doesn't show up in menuconfig, try the following command to
see if you get the correct description: