qi-hardware/openwrt-xburst
1
0
Fork 0
mirror of git://projects.qi-hardware.com/openwrt-xburst.git synced 2024-11-27 17:55:55 +02:00
Code

some more build docs

Browse Source 
git-svn-id: svn://svn.openwrt.org/openwrt/trunk@5648 3c298f89-4303-0410-b956-a3cf2f4a3e73
This commit is contained in:
pavlov 2006-11-26 21:28:16 +00:00
parent 50e59347b4
commit 171c7e4de7
2 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/build.tex
View File

@ -245,7 +245,7 @@ and abstracted to the point where you only need to specify a few variables.
\item \texttt{PKG\_SOURCE} \\ \item \texttt{PKG\_SOURCE} \\
The filename of the original sources The filename of the original sources
\item \texttt{PKG\_SOURCE\_URL} \\ \item \texttt{PKG\_SOURCE\_URL} \\
Where to download the sources from Where to download the sources from (no trailing slash)
\item \texttt{PKG\_MD5SUM} \\ \item \texttt{PKG\_MD5SUM} \\
A checksum to validate the download A checksum to validate the download
\item \texttt{PKG\_CAT} \\ \item \texttt{PKG\_CAT} \\
@ -255,7 +255,9 @@ and abstracted to the point where you only need to specify a few variables.
\end{itemize} \end{itemize}
The \texttt{PKG\_*} variables define where to download the package from; 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 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 \texttt{PKG\_BUILD\_DIR} defines where to find the package after the sources are
uncompressed into \texttt{\$(BUILD\_DIR)}. 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 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. 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 If you find your package doesn't show up in menuconfig, try the following command to
see if you get the correct description: see if you get the correct description:

4
docs/openwrt.tex
View File

@ -4,14 +4,11 @@
\usepackage[T1]{fontenc} \usepackage[T1]{fontenc}
\usepackage{ae,aecompl,aeguill} \usepackage{ae,aecompl,aeguill}
\usepackage{fancyvrb} \usepackage{fancyvrb}
\setlength{\parindent}{0pt} \setlength{\parindent}{0pt}
\setlength{\parskip}\medskipamount \setlength{\parskip}\medskipamount
\begin{document} \begin{document}
\tableofcontents \tableofcontents
\chapter{The Router} \chapter{The Router}
\section{Getting started} \section{Getting started}
\subsection{Installation} \subsection{Installation}
@ -39,5 +36,4 @@
\section{Debugging and debricking} \section{Debugging and debricking}
\subsection{Adding a serial port} \subsection{Adding a serial port}
\subsection{JTAG} \subsection{JTAG}
\end{document} \end{document}