Beginnings of dox for building and installing tools. 2002-08-13 Theodore A. Roth * doc/api/Makefile.am(EXTRA_DIST): Add tools.dox file. * doc/api/tools.dox: New file. Index: doc/api/Makefile.am =================================================================== RCS file: /cvsroot/avr-libc/avr-libc/doc/api/Makefile.am,v retrieving revision 1.13 diff -u -r1.13 Makefile.am --- doc/api/Makefile.am 9 Aug 2002 20:57:27 -0000 1.13 +++ doc/api/Makefile.am 13 Aug 2002 21:02:20 -0000 @@ -39,6 +39,7 @@ inline_asm.dox \ interrupts.dox \ acknowledge.dox \ + tools.dox \ faq.dox SUFFIXES = .pdf Index: doc/api/tools.dox =================================================================== RCS file: doc/api/tools.dox diff -N doc/api/tools.dox --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ doc/api/tools.dox 13 Aug 2002 21:02:20 -0000 @@ -0,0 +1,126 @@ +/* Copyright (c) 2002, Theodore Roth + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + POSSIBILITY OF SUCH DAMAGE. */ + +/* $Id: main_page.dox,v 1.1 2002/07/26 05:49:44 troth Exp $ */ + +/** \page tools The GNU Tool Chain for AVR Development + +[FIXME: write some spiffy stuff here.] + +\note This discussion was taken directly from Rich Neswold's document. (See +\ref acks). + +\note This discussion is Unix specific. If you want to build and install on a +windows system, see [FIXME: troth/2002-08-13: we need a volunteer to work on a +windows specific version of these instructions.] + +\section tools_install Installing the GNU Tools + +This chapter shows how to build and install a complete development environment +for the AVR processors using the GNU toolset. + +I created an area for the AVR tools under \c /usr/local to keep this stuff +separate from the base system. As root, I chown'ed +/usr/local/avr under my normal account. This way, I don't have to be +root to install the tools. All the instructions assume the tools will be +installed in this location. If you want to place them in a different locations +you need to specify the new location using the --prefix option. + +\note If you don't have root access on your system, you can still install the +tools by using --prefix=$HOME/local/avr at configure time. + +\note Be sure that you have your \c PATH environment variable set to search +the directory you install everything in. For example, if you use +--prefix=/usr/local/avr, you must have \c /usr/local/avr/bin in your +exported \c PATH \e before you start installing anything. + +\note The versions for the packages listed below are known to work together. +If you mix and match different versions, you may have problems. + +\subsection required_tools Required Tools + + + + + + + + + + + + + + + + + + + + + + +
ToolVersionLocation
GNU Binutils2.13.90http://sources.redhat.com/binutils/
GCC3.3http://gcc.gnu.org/
AVR libcHead of current CVS treehttp://savannah.gnu.org/projects/avr-libc/
+ +\note The versions mentioned above are still considered experimental and you +may have to get them from cvs. Significant changes have been made which are +not compatible with previous stable releases. These incompatilities should be +noted in the documentation. + +\subsection optional_tools Optional Tools + +You can develop programs for AVR devices with the following tools. They may +or may not be of use for you. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ToolVersionLocation
uisp20020626http://savannah.gnu.org/projects/uisp/
GDB5.2.1http://sources.redhat.com/gdb/
Simulavr0.1.0http://savannah.gnu.org/projects/simulavr/
AVaRice1.5http://avarice.sourceforge.net/
+ + +*/