-----------------------
If you would rather be working "with" OpenOCD rather than "on" it, your
-operating system or interface supplier may provide binaries for you in a
-convenient package.
+operating system or JTAG interface supplier may provide binaries for
+you in a convenient-enough package.
-Such packages should be more stable than SVN trunk, where bleeding-edge
+Such packages may be more stable than git mainline, where bleeding-edge
development takes place. These "Packagers" produce binary releases of
-OpenOCD after the developers produces new "stable" versions of the
-source code. Previous versions of OpenOCD cannot be used to diagnosed
+OpenOCD after the developers produces new "release" versions of the
+source code. Previous versions of OpenOCD cannot be used to diagnose
problems with the current release, so users are encouraged to keep in
contact with their distribution package maintainers or interface vendors
to ensure suitable upgrades appear regularly.
--enable-maintainer-mode enable make rules and dependencies not useful
(and sometimes confusing) to the casual installer
- NOTE: This option is *required* for SVN builds!
+ NOTE: This option is *required* for GIT builds!
It should *not* be used to build a release.
--enable-dummy Enable building the dummy JTAG port driver
--enable-httpd Enable builtin httpd server - useful for standalone
OpenOCD implementations
+ --disable-doxygen-html Disable building Doxygen manual as HTML.
+ --enable-doxygen-pdf Enable building Doxygen manual as PDF.
+
Miscellaneous Configure Options
-------------------------------
copies for personal use.
The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
-TAR.GZ file. You must unpack them ``some where'' convient. As of this
+TAR.GZ file. You must unpack them ``some where'' convenient. As of this
writing FTDICHIP does not supply means to install these files "in an
appropriate place."
Note that on Linux there is no good reason to use these FTDI binaries;
they are no faster (on Linux) than libftdi, and cause licensing issues.
-=================================
-Obtaining OpenOCD From Subversion
----------------------------------
+==========================
+Obtaining OpenOCD From GIT
+==========================
+
+You can download the current GIT version with a GIT client of your
+choice from the main repository:
+
+ git://openocd.git.sourceforge.net/gitroot/openocd/openocd
+
+You may prefer to use a mirror:
+
+ http://repo.or.cz/r/openocd.git
+ git://repo.or.cz/openocd.git
+
+Using the GIT command line client, you might use the following command
+to set up a local copy of the current repository (make sure there is no
+directory called "openocd" in the current directory):
+
+ git clone git://openocd.git.sourceforge.net/gitroot/openocd/openocd
-You can download the current SVN version with an SVN client of your
-choice from the following repositories:
+Then you can update that at your convenience using
- svn://svn.berlios.de/openocd/trunk
-or
- http://svn.berlios.de/svnroot/repos/openocd/trunk
+ git pull
-Using the SVN command line client, you can use the following command to
-fetch the latest version (make sure there is no (non-svn) directory
-called "openocd" in the current directory):
+There is also a gitweb interface, which you can use either to browse
+the repository or to download arbitrary snapshots using HTTP:
- svn checkout svn://svn.berlios.de/openocd/trunk openocd
+ http://openocd.git.sourceforge.net/git/gitweb.cgi?p=openocd/openocd
+ http://repo.or.cz/w/openocd.git
-If you prefer GIT based tools, the git-svn package works too:
+Snapshots are compressed tarballs of the source tree, about 1.3 MBytes
+each at this writing.
- git svn clone -s svn://svn.berlios.de/openocd
-Tips For Building From The Subversion Repository
-************************************************
+Tips For Building From a GIT Repository
+---------------------------------------
Building OpenOCD from a repository requires a recent version of the GNU
autotools (autoconf >= 2.59 and automake >= 1.9).
Code Review / openocd.git / blobdiff