Changeset 8138481 in freewrt


Ignore:
Timestamp:
Dec 17, 2006, 9:56:00 PM (19 years ago)
Author:
Waldemar Brodkorb <wbx@…>
Branches:
freewrt_1_0, freewrt_2_0
Children:
365f890
Parents:
5cfe1bc
Message:

add some minor changes, remove some comments, remove the name buildroot

git-svn-id: ​svn://www.freewrt.org/branches/freewrt_1_0@1307 afb5a338-a214-0410-bd46-81f09a774fd1

Location:
docs/handbook/user
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • docs/handbook/user/00-allinone.tex

    r5cfe1bc r8138481  
    77systems. The latest version of this document is always available at the
    88FreeWRT website. If you have any comments, criticism or found some wrong
    9 description, please send us an eMail to freewrt-handbook@freewrt.org, we are
     9description, please send us an e-mail to freewrt-handbook@freewrt.org, we are
    1010always happy about getting feedback to this document, and will try to update
    1111or correct the issues mentioned by you.
    … …  
    3737\end{Verbatim}
    3838
    39 Examples staring with \$ indicate a command that can be invoked as a normal
     39Examples starting with \$ indicate a command that can be invoked as a normal
    4040user.  The default user account on a freshly installed FreeWRT system is
    4141,,admin''.
    … …  
    4747\chapter{Appliance Development Kit (ADK)}
    4848
    49 Our appliance development kit is called ,,buildroot''. The ADK is the core of
    50 FreeWRT and contains all scripts and sources to create firmware images for
    51 every supported embedded system. FreeWRT 1.0 supports the following embedded
    52 systems:
     49The ADK is the core of FreeWRT and contains all scripts and sources to create
     50firmware images for every supported embedded system. FreeWRT 1.0 supports the
     51following embedded systems:
    5352
    5453\begin{itemize}
    … …  
    7271
    7372In this release we only support the Linux 2.4 kernel. The ADK contains over
    74 300 software packages.
     73600 software packages.
    7574
    7675\section{Prerequisites}
    … …  
    8483\item Ubuntu Dapper Drake or newer
    8584\item Fedora Core 4 or newer
    86 \item OpenBSD 3.9 or newer
    87 \item MirOS BSD
     85\item OpenBSD 3.9 or newer (partial support)\footnote{some addon packages does not compile}
     86\item MirOS BSD (partial support)\footnote{some addon packages does not compile}
    8887\end{itemize}
    8988
    … …  
    107106\item ncurses (+headers)
    108107\item (g)libc headers
    109 \item subversion
    110108\item perl
    111109\end{itemize}
    … …  
    113111The buildroot checks for the required versions of these tools in advance.
    114112
    115 To build FreeWRT with buildroot it is recommended to have an unprivileged
     113To build FreeWRT with the ADK it is recommended to have an unprivileged
    116114user. Please \underline{never} build FreeWRT as super user. Because all necessary source
    117115tarballs are downloaded from the internet automatically, your host system
    … …  
    122120Now go to a directory where you want to build the firmware. Depending on the
    123121features you select you will need about 2.5-5 GB free disk space. This
    124 includes the buildroot itself, any source archives which will be downloaded
     122includes the ADK itself, any source archives which will be downloaded
    125123and their extracted copies (for compiling).
    126124
    127 To get the initial FreeWRT 1.0 buildroot try one of these commands:
     125To get the initial FreeWRT 1.0 ADK try one of these commands:
    128126\begin{Verbatim}
    129127$ svn co http://www.freewrt.org/svn/branches/freewrt_1_0 freewrt
    … …  
    173171
    174172\subsection{Building ADK}
    175 Now that you have a (first) configuration, it is time to build the toolchain
    176 (compiler, libraries) for cross-compiling. To do this, just enter {{{make}}}
    177 again. The build starts downloading and compiling each needed part of the
    178 toolchain, and later continues with building the first firmware image. Later
    179 one can be taken as proof of a working ADK.
     173
     174Now that you have a first minimal configuration, it is time to build the toolchain
     175for cross-compiling. To do this, just enter {{{make}}} again. The build starts
     176downloading and compiling each needed part of the toolchain, and later continues
     177with building the first firmware image. Later one can be taken as proof of a
     178working ADK.
    180179
    181180Already experienced in compiling gcc? Then you know... If not, better be told
    182181that it takes \underline{really long} to finish. In the meantime I suggest reading the
    183 next (optional) chapter dealing with internals about cross-compiling.
     182next chapter dealing with internals about cross-compiling.
    184183
    185184\section{Details Of Cross-Compiling}
    … …  
    199198\end{enumerate}
    200199
    201 The cross-compile toolchain is created in ,,staging\_dir\_\$cpu\_arch''.  All the
    202 tools running on the host, but used to create, analyze or debug for the target are
    203 kept in this directory. All addon package headers and libraries are installed to
    204 this directory.
     200The cross-compile toolchain is created in
     201,,staging\_dir\_\$(cpu\_arch)''\footnote{f.e. mipsel, which stands for MIPS Little
     202Endian)}.  All the tools running on the host, but used to create, analyze or debug
     203for the target are kept in this directory. All addon headers and libraries
     204are installed to this directory.
    205205
    206206If you want to compile a simple application without using the ADK, just use the
    … …  
    213213\begin{verbatim}
    214214$ file myapp
    215 myapp: ELF 32-bit LSB MIPS-I executable, MIPS, version 1 (SYSV), dynamically linked
    216 (uses shared libs), not stripped
     215myapp: ELF 32-bit LSB MIPS-I executable, MIPS, version 1 (SYSV), dynamically
     216linked (uses shared libs), not stripped
    217217\end{verbatim}
    218218
    219219\section{Building A FreeWRT Firmware Image}
    220220
    221 Ok. Your local copy of the FreeWRT ADK should now be prepared for building
     221Your local copy of the FreeWRT ADK should now be prepared for building firmware
    222222images. The next step is to do an extensive configuration for the image you
    223 want to create. To start the configuration menu, type {{{make menuconfig}}}.
     223want to create. To start the configuration menu, type ,,\texttt{make menuconfig}''.
    224224
    225225When selecting packages, \texttt{<*>} means it will be inserted into the firmware
    226226images and \texttt{<M>} means it will be build as an addon package which can be
    227 installed later.
    228 
    229 The target device and filesystem should already been chosen by you to the
    230 right value, if not you will have to issue a \texttt{make clean} before actually
    231 building the firmware image, because otherwise things get messed up. (smooth
    232 rebuild is a missing feature in our buildroot.) For the packages, if
    233 unsure, you can just select one of the package collections. After that, you
    234 can still manually check the choices made by the collection and correct them
    235 if appropriate. Do not forget to save your configuration when leaving!
    236 
    237 Guess ... right, type \texttt{make} again to build the new FreeWRT firmware
    238 image. Depending on your package selections and underlying hardware, this will
    239 take different amounts of time. For your spare time there is the following
    240 chapter giving some explanation about what is done at this point.
     227installed later at runtime.
     228
     229The target device and filesystem should already been chosen by you to the right
     230value, if not you will have to issue a ,,\texttt{make clean}'' before actually
     231building the firmware image. Otherwise things get messed up. A smooth
     232rebuild is a missing feature in the current ADK. For the packages, if unsure, you
     233can just select one of the package collections. After that, you can still manually
     234check the choices made by the collection and correct them if appropriate. Do not
     235forget to save your configuration when leaving!
     236
     237After leaving the menubased configuration, type ,,\texttt{make}'' again to build
     238the new FreeWRT firmware image. Depending on your package selections and
     239underlying hardware, this will take different amounts of time. For your spare time
     240there is the following chapter giving some explanation about what is done at this
     241point.
    241242
    242243\section{Firmware Build Process In Detail}
    … …  
    249250
    250251\begin{itemize}
    251 \item compile the Linux kernel and all kernel modules
     252\item compile the Linux kernel and all supported kernel modules
    252253\item compile all selected packages
    253254\item clean the target root directory
    … …  
    258259
    259260The result of the build process is created in the ,,bin'' directory.
     261You will find a firmware image in the top level directory. Check the size of
     262the bin-file to see if it is small enough to fit into flash memory of
     263your embedded system. Furthermore there is a ,,package'' directory, which
     264contains all base and addon packages.
    260265
    261266\section{Troubleshooting}
    262 This section deals with various tips for problems with ADK installation.
     267This section deals with various tips for problems with the ADK installation.
    263268
    264269\subsection{Errors During Prerequisites Check}
    … …  
    267272\begin{itemize}
    268273\item GNU make 3.80 too old
    269    On a FC4 buildsystem the first you'll get is
    270 \begin{Verbatim}
     274   On a Fedora Core 4 hostsystem the first you'll get is
     275\begin{verbatim}
    271276   $ make
    272277   GNU make 3.80 too old.
    … …  
    276281   GNU Bison 2.3 because of its bug fixes.
    277282   make: *** [.prereq_done] Error 1
    278 \end{Verbatim}
     283\end{verbatim}
    279284
    280285   it is quite a nice error that tells you to use more up to date software, but we can
    281286   anyhow give this hostsystem a try and tell make to ignore those errors/warnings:
    282 \begin{Verbatim}
     287\begin{verbatim}
    283288     make prereq-noerror
    284 \end{Verbatim}
     289\end{verbatim}
     290\end{itemize}
     291
     292\subsection{Compilation errors}
     293
     294If you encounter any compilation errors, then first try to reproduce the error.
     295First update your ADK tree via ,,svn update'', to be sure that the error is not
     296already fixed in the subversion repository. After that do a ,,make clean \&\&
     297make'', to reproduce your problem.
     298
     299If you can reproduce the problem, please file a bug report. Please always
     300report following information:
     301\begin{itemize}
     302\item Operating system type and version
     303\item GCC and Binutils versions of your host system
     304\item complete error message, not only the last 4 lines
    285305\end{itemize}
    286306
    287307\chapter{Installing FreeWRT Firmware Images}
     308
    288309The FreeWRT ADK produces a single image holding both kernel and root
    289310filesystem. This image can be written into your hardware's builtin flash memory

  • docs/handbook/user/cover.tex

    r5cfe1bc r8138481  
    77\\
    88\sectfont \huge
    9 \leftline{The FreeWRT Handbook}
     9\leftline{The FreeWRT User Handbook}
    1010\\
    1111\rule[0.3ex]{\linewidth}{3.5pt}
    … …  
    1414\normalfont \footnotesize
    1515\rightline{%
    16 % Dies ist der Untertitel fuer das Realtime Ethernet Projekt
    1716The FreeWRT Project
    1817}
    … …  
    2120Revision 1.0}
    2221\\
    23 %\rightline{%
    24 %Prof. Dr. Peter Fleischer}
    25 %Meiner Einer und Deiner Einer}
    26 %\\
    2722\rightline{%
    28 %Furtwangen, \today
    29 Bobbale, \today
     23World, \today
    3024}
    3125\vfill
    … …  
    4236\textbf{Phil Richard Sutter} \texttt{<n0-1@freewrt.org>}
    4337\\
     38\textbf{Dirk Nehring} \texttt{<dnehring@freewrt.org>}
     39\\
     40\textbf{Markus Wigge} \texttt{<markus@freewrt.org>}
     41\\
     42\textbf{Michael Schwab} \texttt{<ms@freewrt.org>}
     43\\
    4444\vspace{.1cm}
    45 %Fachhochschule Furtwangen
    46 %Nen Institut
    47 %\\
    48 %Studiengang Computer Networking -- Fachbereich Informatik
    49 %Geblubb zum Institut
    50 %\\
    5145\rule[1.2ex]{\linewidth}{1pt}
    5246\end{flushleft}
Note: See TracChangeset for help on using the changeset viewer.