-Prerequisites
-=============
-
-When building with support for FTDI FT2232 based devices, you need at least
-one of the following libraries:
-
-- libftdi (http://www.intra2net.com/opensource/ftdi/)
-- libftd2xx (http://www.ftdichip.com/Drivers/D2XX.htm)
-
-On Windows, you need either Cygwin or MinGW, but compilation for MinGW is also
-possible using a Cygwin host.
-
-Basic Installation
-==================
-
- OpenOCD is distributed without autotools generated files, i.e. without a
-configure script. Run ./bootstrap in the openocd directory to have all
-necessary files generated.
-
- You have to explicitly enable desired JTAG interfaces during configure:
-
-./configure --enable-parport --enable-ft2232-libftdi (OR --enable-ft2232-ftd2xx) \
- --enable-amtjtagaccel
-
- Under Windows/Cygwin, only the ftd2xx driver is supported for FT2232 based
-devices. You have to specify the location of the FTDI driver package with the
---with-ftd2xx=/full/path/name option.
-
-Under Linux you can choose to build the parport driver with support for
-/dev/parportN instead of the default access with direct port I/O using
---enable-parport_ppdev. This has the advantage of running OpenOCD without root
-privileges at the expense of a slight performance decrease. This is also
-available on FreeBSD using PPI, but the naming of the devices is different.
-
-Generic installation instructions
-=================================
-
- These are generic installation instructions.
-
- The `configure' shell script attempts to guess correct values for
-various system-dependent variables used during compilation. It uses
-those values to create a `Makefile' in each directory of the package.
-It may also create one or more `.h' files containing system-dependent
-definitions. Finally, it creates a shell script `config.status' that
-you can run in the future to recreate the current configuration, a file
-`config.cache' that saves the results of its tests to speed up
-reconfiguring, and a file `config.log' containing compiler output
-(useful mainly for debugging `configure').
-
- If you need to do unusual things to compile the package, please try
-to figure out how `configure' could check whether to do them, and mail
-diffs or instructions to the address given in the `README' so they can
-be considered for the next release. If at some point `config.cache'
-contains results you don't want to keep, you may remove or edit it.
-
- The file `configure.in' is used to create `configure' by a program
-called `autoconf'. You only need `configure.in' if you want to change
-it or regenerate `configure' using a newer version of `autoconf'.
-
-The simplest way to compile this package is:
-
- 1. `cd' to the directory containing the package's source code and type
- `./configure' to configure the package for your system. If you're
- using `csh' on an old version of System V, you might need to type
- `sh ./configure' instead to prevent `csh' from trying to execute
- `configure' itself.
-
- Running `configure' takes a while. While running, it prints some
- messages telling which features it is checking for.
-
- 2. Type `make' to compile the package.
-
- 3. Type `make install' to install the programs and any data files and
- documentation.
-
- 4. You can remove the program binaries and object files from the
- source code directory by typing `make clean'.
-
-Compilers and Options
-=====================
-
- Some systems require unusual options for compilation or linking that
-the `configure' script does not know about. You can give `configure'
-initial values for variables by setting them in the environment. Using
-a Bourne-compatible shell, you can do that on the command line like
-this:
- CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
-
-Or on systems that have the `env' program, you can do it like this:
- env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
-
-Compiling For Multiple Architectures
-====================================
-
- You can compile the package for more than one kind of computer at the
-same time, by placing the object files for each architecture in their
-own directory. To do this, you must use a version of `make' that
-supports the `VPATH' variable, such as GNU `make'. `cd' to the
-directory where you want the object files and executables to go and run
-the `configure' script. `configure' automatically checks for the
-source code in the directory that `configure' is in and in `..'.
-
- If you have to use a `make' that does not supports the `VPATH'
-variable, you have to compile the package for one architecture at a time
-in the source code directory. After you have installed the package for
-one architecture, use `make distclean' before reconfiguring for another
-architecture.
-
-Installation Names
-==================
-
- By default, `make install' will install the package's files in
-`/usr/local/bin', `/usr/local/man', etc. You can specify an
-installation prefix other than `/usr/local' by giving `configure' the
-option `--prefix=PATH'.
-
- You can specify separate installation prefixes for
-architecture-specific files and architecture-independent files. If you
-give `configure' the option `--exec-prefix=PATH', the package will use
-PATH as the prefix for installing programs and libraries.
-Documentation and other data files will still use the regular prefix.
-
- If the package supports it, you can cause programs to be installed
-with an extra prefix or suffix on their names by giving `configure' the
-option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
-
-Optional Features
-=================
-
- Some packages pay attention to `--enable-FEATURE' options to
-`configure', where FEATURE indicates an optional part of the package.
-They may also pay attention to `--with-PACKAGE' options, where PACKAGE
-is something like `gnu-as' or `x' (for the X Window System). The
-`README' should mention any `--enable-' and `--with-' options that the
-package recognizes.
-
- For packages that use the X Window System, `configure' can usually
-find the X include and library files automatically, but if it doesn't,
-you can use the `configure' options `--x-includes=DIR' and
-`--x-libraries=DIR' to specify their locations.
-
-Specifying the System Type
-==========================
-
- There may be some features `configure' can not figure out
-automatically, but needs to determine by the type of host the package
-will run on. Usually `configure' can figure that out, but if it prints
-a message saying it can not guess the host type, give it the
-`--host=TYPE' option. TYPE can either be a short name for the system
-type, such as `sun4', or a canonical name with three fields:
- CPU-COMPANY-SYSTEM
-
-See the file `config.sub' for the possible values of each field. If
-`config.sub' isn't included in this package, then this package doesn't
-need to know the host type.
-
- If you are building compiler tools for cross-compiling, you can also
-use the `--target=TYPE' option to select the type of system they will
-produce code for and the `--build=TYPE' option to select the type of
-system on which you are compiling the package.
-
-Sharing Defaults
-================
-
- If you want to set default values for `configure' scripts to share,
-you can create a site shell script called `config.site' that gives
-default values for variables like `CC', `cache_file', and `prefix'.
-`configure' looks for `PREFIX/share/config.site' if it exists, then
-`PREFIX/etc/config.site' if it exists. Or, you can set the
-`CONFIG_SITE' environment variable to the location of the site script.
-A warning: not all `configure' scripts look for a site script.
-
-Operation Controls
-==================
-
- `configure' recognizes the following options to control how it
-operates.
-
-`--cache-file=FILE'
- Use and save the results of the tests in FILE instead of
- `./config.cache'. Set FILE to `/dev/null' to disable caching, for
- debugging `configure'.
-
-`--help'
- Print a summary of the options to `configure', and exit.
-
-`--quiet'
-`--silent'
-`-q'
- Do not print messages saying which checks are being made.
-
-`--srcdir=DIR'
- Look for the package's source code in directory DIR. Usually
- `configure' can determine that directory automatically.
-
-`--version'
- Print the version of Autoconf used to generate the `configure'
- script, and exit.
-
-`configure' also accepts some other, not widely useful, options.
-
+openocd.texi is the authortative source of OpenOCD documentation
\ No newline at end of file
-
-2008-01-21 :
- xscale big-endian branch closed and all changes moved to
- trunk.
-
+This document is not in use. See mailing list.
\ No newline at end of file
--- /dev/null
+TODO!!! this should be merged into openocd.texi!!!\r
+\r
+\r
+Prerequisites\r
+=============\r
+\r
+When building with support for FTDI FT2232 based devices, you need at least\r
+one of the following libraries:\r
+\r
+- libftdi (http://www.intra2net.com/opensource/ftdi/)\r
+- libftd2xx (http://www.ftdichip.com/Drivers/D2XX.htm)\r
+\r
+On Windows, you need either Cygwin or MinGW, but compilation for MinGW is also\r
+possible using a Cygwin host.\r
+\r
+Basic Installation\r
+==================\r
+\r
+ OpenOCD is distributed without autotools generated files, i.e. without a \r
+configure script. Run ./bootstrap in the openocd directory to have all\r
+necessary files generated.\r
+\r
+ You have to explicitly enable desired JTAG interfaces during configure:\r
+\r
+./configure --enable-parport --enable-ft2232-libftdi (OR --enable-ft2232-ftd2xx) \\r
+ --enable-amtjtagaccel\r
+\r
+ Under Windows/Cygwin, only the ftd2xx driver is supported for FT2232 based\r
+devices. You have to specify the location of the FTDI driver package with the\r
+--with-ftd2xx=/full/path/name option.\r
+\r
+Under Linux you can choose to build the parport driver with support for\r
+/dev/parportN instead of the default access with direct port I/O using\r
+--enable-parport_ppdev. This has the advantage of running OpenOCD without root\r
+privileges at the expense of a slight performance decrease. This is also\r
+available on FreeBSD using PPI, but the naming of the devices is different.\r
+\r
+Generic installation instructions\r
+=================================\r
+\r
+ These are generic installation instructions.\r
+\r
+ The `configure' shell script attempts to guess correct values for\r
+various system-dependent variables used during compilation. It uses\r
+those values to create a `Makefile' in each directory of the package.\r
+It may also create one or more `.h' files containing system-dependent\r
+definitions. Finally, it creates a shell script `config.status' that\r
+you can run in the future to recreate the current configuration, a file\r
+`config.cache' that saves the results of its tests to speed up\r
+reconfiguring, and a file `config.log' containing compiler output\r
+(useful mainly for debugging `configure').\r
+\r
+ If you need to do unusual things to compile the package, please try\r
+to figure out how `configure' could check whether to do them, and mail\r
+diffs or instructions to the address given in the `README' so they can\r
+be considered for the next release. If at some point `config.cache'\r
+contains results you don't want to keep, you may remove or edit it.\r
+\r
+ The file `configure.in' is used to create `configure' by a program\r
+called `autoconf'. You only need `configure.in' if you want to change\r
+it or regenerate `configure' using a newer version of `autoconf'.\r
+\r
+The simplest way to compile this package is:\r
+\r
+ 1. `cd' to the directory containing the package's source code and type\r
+ `./configure' to configure the package for your system. If you're\r
+ using `csh' on an old version of System V, you might need to type\r
+ `sh ./configure' instead to prevent `csh' from trying to execute\r
+ `configure' itself.\r
+\r
+ Running `configure' takes a while. While running, it prints some\r
+ messages telling which features it is checking for.\r
+\r
+ 2. Type `make' to compile the package.\r
+\r
+ 3. Type `make install' to install the programs and any data files and\r
+ documentation.\r
+\r
+ 4. You can remove the program binaries and object files from the\r
+ source code directory by typing `make clean'. \r
+\r
+Compilers and Options\r
+=====================\r
+\r
+ Some systems require unusual options for compilation or linking that\r
+the `configure' script does not know about. You can give `configure'\r
+initial values for variables by setting them in the environment. Using\r
+a Bourne-compatible shell, you can do that on the command line like\r
+this:\r
+ CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure\r
+\r
+Or on systems that have the `env' program, you can do it like this:\r
+ env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure\r
+\r
+Compiling For Multiple Architectures\r
+====================================\r
+\r
+ You can compile the package for more than one kind of computer at the\r
+same time, by placing the object files for each architecture in their\r
+own directory. To do this, you must use a version of `make' that\r
+supports the `VPATH' variable, such as GNU `make'. `cd' to the\r
+directory where you want the object files and executables to go and run\r
+the `configure' script. `configure' automatically checks for the\r
+source code in the directory that `configure' is in and in `..'.\r
+\r
+ If you have to use a `make' that does not supports the `VPATH'\r
+variable, you have to compile the package for one architecture at a time\r
+in the source code directory. After you have installed the package for\r
+one architecture, use `make distclean' before reconfiguring for another\r
+architecture.\r
+\r
+Installation Names\r
+==================\r
+\r
+ By default, `make install' will install the package's files in\r
+`/usr/local/bin', `/usr/local/man', etc. You can specify an\r
+installation prefix other than `/usr/local' by giving `configure' the\r
+option `--prefix=PATH'.\r
+\r
+ You can specify separate installation prefixes for\r
+architecture-specific files and architecture-independent files. If you\r
+give `configure' the option `--exec-prefix=PATH', the package will use\r
+PATH as the prefix for installing programs and libraries.\r
+Documentation and other data files will still use the regular prefix.\r
+\r
+ If the package supports it, you can cause programs to be installed\r
+with an extra prefix or suffix on their names by giving `configure' the\r
+option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.\r
+\r
+Optional Features\r
+=================\r
+\r
+ Some packages pay attention to `--enable-FEATURE' options to\r
+`configure', where FEATURE indicates an optional part of the package.\r
+They may also pay attention to `--with-PACKAGE' options, where PACKAGE\r
+is something like `gnu-as' or `x' (for the X Window System). The\r
+`README' should mention any `--enable-' and `--with-' options that the\r
+package recognizes.\r
+\r
+ For packages that use the X Window System, `configure' can usually\r
+find the X include and library files automatically, but if it doesn't,\r
+you can use the `configure' options `--x-includes=DIR' and\r
+`--x-libraries=DIR' to specify their locations.\r
+\r
+Specifying the System Type\r
+==========================\r
+\r
+ There may be some features `configure' can not figure out\r
+automatically, but needs to determine by the type of host the package\r
+will run on. Usually `configure' can figure that out, but if it prints\r
+a message saying it can not guess the host type, give it the\r
+`--host=TYPE' option. TYPE can either be a short name for the system\r
+type, such as `sun4', or a canonical name with three fields:\r
+ CPU-COMPANY-SYSTEM\r
+\r
+See the file `config.sub' for the possible values of each field. If\r
+`config.sub' isn't included in this package, then this package doesn't\r
+need to know the host type.\r
+\r
+ If you are building compiler tools for cross-compiling, you can also\r
+use the `--target=TYPE' option to select the type of system they will\r
+produce code for and the `--build=TYPE' option to select the type of\r
+system on which you are compiling the package.\r
+\r
+Sharing Defaults\r
+================\r
+\r
+ If you want to set default values for `configure' scripts to share,\r
+you can create a site shell script called `config.site' that gives\r
+default values for variables like `CC', `cache_file', and `prefix'.\r
+`configure' looks for `PREFIX/share/config.site' if it exists, then\r
+`PREFIX/etc/config.site' if it exists. Or, you can set the\r
+`CONFIG_SITE' environment variable to the location of the site script.\r
+A warning: not all `configure' scripts look for a site script.\r
+\r
+Operation Controls\r
+==================\r
+\r
+ `configure' recognizes the following options to control how it\r
+operates.\r
+\r
+`--cache-file=FILE'\r
+ Use and save the results of the tests in FILE instead of\r
+ `./config.cache'. Set FILE to `/dev/null' to disable caching, for\r
+ debugging `configure'.\r
+\r
+`--help'\r
+ Print a summary of the options to `configure', and exit.\r
+\r
+`--quiet'\r
+`--silent'\r
+`-q'\r
+ Do not print messages saying which checks are being made.\r
+\r
+`--srcdir=DIR'\r
+ Look for the package's source code in directory DIR. Usually\r
+ `configure' can determine that directory automatically.\r
+\r
+`--version'\r
+ Print the version of Autoconf used to generate the `configure'\r
+ script, and exit.\r
+\r
+`configure' also accepts some other, not widely useful, options.\r
+\r
Code Review / openocd.git / commitdiff