Peter Denison <openwrt@marshadder.org> workaround for broken USBprog w/short tms...

[openocd.git] / README

diff --git a/README b/README
index 07ccac1839149eaf3cb7c45c73db9d603f114f58..537bb0cbd28857e0f211269646f8650394f87f03 100644 (file)
--- a/README
+++ b/README
@@ -51,10 +51,11 @@ The OpenOCD User's Guide can be produced in two different format:
 The OpenOCD Developer Manual contains information about the internal
 architecture and other details about the code:
 
+  # NB! make sure doxygen is installed, type doxygen --version
   make doxygen
 
   # If HTMLVIEWER is set, this views the HTML Doxygen output.
-  ${HTMLVIEWER} doxyegen/index.html
+  ${HTMLVIEWER} doxygen/index.html
 
 The remaining sections describe how to configure the system such that
 you can build the in-tree documentation.
@@ -165,6 +166,29 @@ will build OpenOCD and place the final executable in ./src/.  The
 final (optional) step, ``make install'', places all of the files in the
 required location.
 
+Cross-Compiling Options
+-----------------------
+
+To cross-compile, you must specify both --build and --host options to
+the 'configure' script.  For example, you can configure OpenOCD to
+cross-compile on a x86 Linux host to run on Windows (MinGW32), you could
+use the following configuration options:
+
+  ./configure --build=i686-pc-linux-gnu --host=i586-mingw32msvc ... 
+
+Likewise, the following options allow OpenOCD to be cross-compiled for
+an ARM target on the same x86 host:
+
+  ./configure --build=i686-pc-linux-gnu --host=arm-elf ...
+
+Both must be specified to work around bugs in autoconf.
+
+Scripts for producing ARM cross-compilers can be found on the web with a
+little searching.  A script to produce an x86 Linux-hosted MinGW32
+cross-compiler can be downloaded from the following URL:
+
+  http://www.mingw.org/wiki/LinuxCrossMinGW
+
 Configuration Options
 ---------------------
 
@@ -252,11 +276,6 @@ The following additional options may also be useful:
   --disable-wextra        Disable extra compiler warnings
   --disable-werror        Do not treat warnings as errors
 
-  --enable-release        Enable building of an OpenOCD release.  This
-                         option is intended for project maintainers.
-                         It simply omits the svn version string when
-                         the openocd -v is executed (to KISS).
-
   --disable-option-checking
                           Ignore unrecognized --enable and --with options.
   --disable-dependency-tracking  speeds up one-time build