This is an automated email from Gerrit. "Marc Schink <[email protected]>" just uploaded a new patch set to Gerrit, which you can find at https://review.openocd.org/c/openocd/+/9404
-- gerrit commit 1ffec6228b8844010ea3e70ec74a03a0a809323a Author: Marc Schink <[email protected]> Date: Mon Jan 26 07:41:39 2026 +0100 README.md: Fix Markdown linter errors Adjust Markdown formatting to satisfy the Markdown linter [1], no content changes are included. [1] https://github.com/jackdewinter/pymarkdown Change-Id: I28a2e8d12bfab08017de330ae3e81239082110ff Signed-off-by: Marc Schink <[email protected]> diff --git a/README.md b/README.md index eb880e059c..fc7d60264a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Welcome to OpenOCD! +# Welcome to OpenOCD OpenOCD provides on-chip programming and debugging support with a layered architecture of JTAG interface and TAP support including: @@ -24,34 +24,36 @@ This README file contains an overview of the following topics: - the installation and build process, - packaging tips. - -# Quickstart for the impatient +## Quickstart for the impatient If you have a popular board then just start OpenOCD with its config, e.g.: - openocd -f board/stm32f4discovery.cfg +```sh +openocd -f board/stm32f4discovery.cfg +``` If you are connecting a particular adapter with some specific target, you need to source both the jtag interface and the target configs, e.g.: -``` +```sh openocd -f interface/ftdi/jtagkey2.cfg -c "transport select jtag" \ -f target/ti/calypso.cfg ``` -``` +```sh openocd -f interface/stlink.cfg -c "transport select swd" \ -f target/stm32l0.cfg ``` After OpenOCD startup, connect GDB with - (gdb) target extended-remote localhost:3333 - +```gdb +(gdb) target extended-remote localhost:3333 +``` -# Installing OpenOCD +## Installing OpenOCD The easiest way to install OpenOCD is through your operating system's package manager. @@ -119,27 +121,22 @@ suggestions: particular hardware; - Use "ftdi" interface adapter driver for the FTDI-based devices. - -# OpenOCD Documentation +## OpenOCD Documentation In addition to the in-tree documentation, the latest manuals may be viewed online at the following URLs: - OpenOCD User's Guide: - http://openocd.org/doc/html/index.html +- OpenOCD User's Guide: <http://openocd.org/doc/html/index.html> - OpenOCD Developer's Manual: - http://openocd.org/doc/doxygen/html/index.html +- OpenOCD Developer's Manual: <http://openocd.org/doc/doxygen/html/index.html> These reflect the latest development versions, so the following section introduces how to build the complete documentation from the package. For more information, refer to these documents or contact the developers -by subscribing to the OpenOCD developer mailing list: - - [email protected] +by subscribing to the OpenOCD developer mailing list: [email protected] -## Building the OpenOCD Documentation +### Building the OpenOCD Documentation By default the OpenOCD build process prepares documentation in the "Info format" and installs it the standard way, so that `info openocd` @@ -150,23 +147,28 @@ following different formats: If `PDFVIEWER` is set, this creates and views the PDF User Guide. - make pdf && ${PDFVIEWER} doc/openocd.pdf +```sh +make pdf && ${PDFVIEWER} doc/openocd.pdf +``` If `HTMLVIEWER` is set, this creates and views the HTML User Guide. - make html && ${HTMLVIEWER} doc/openocd.html/index.html +```sh +make html && ${HTMLVIEWER} doc/openocd.html/index.html +``` The OpenOCD Developer Manual contains information about the internal architecture and other details about the code: Note: make sure doxygen is installed, type doxygen --version - make doxygen && ${HTMLVIEWER} doxygen/index.html - +```sh +make doxygen && ${HTMLVIEWER} doxygen/index.html +``` -# Supported hardware +## Supported hardware -## JTAG adapters +### JTAG adapters AM335x, ARM-JTAG-EW, ARM-USB-OCD, ARM-USB-TINY, AT91RM9200, axm0432, BCM2835, Bus Blaster, Buspirate, Cadence DPI, Cadence vdebug, Chameleon, CMSIS-DAP, @@ -183,7 +185,7 @@ sysfsgpio, Tigard, TI XDS110, TUMPA, Turtelizer, ULINK, USB-A9260, USB-Blaster, USB-JTAG, USBprog, VPACLink, VSLLink, Wiggler, XDS100v2, Xilinx XVC/PCIe, Xverve. -## Debug targets +### Debug targets ARM: AArch64, ARM11, ARM7, ARM9, Cortex-A/R (v7-A/R), Cortex-M (ARMv{6/7/8}-M), FA526, Feroceon/Dragonite, XScale. @@ -191,7 +193,7 @@ ARCv2, AVR32, DSP563xx, DSP5680xx, EnSilica eSi-RISC, EJTAG (MIPS32, MIPS64), ESP32, ESP32-S2, ESP32-S3, Intel Quark, LS102x-SAP, RISC-V, ST STM8, Xtensa. -## Flash drivers +### Flash drivers ADUC702x, AT91SAM, AT91SAM9 (NAND), ATH79, ATmega128RFA1, Atmel SAM, AVR, CFI, DSP5680xx, EFM32, EM357, eSi-RISC, eSi-TSMC, EZR32HG, FM3, FM4, Freedom E SPI, @@ -204,7 +206,7 @@ STM32 QUAD/OCTO-SPI for Flash/FRAM/EEPROM, STMSMI, STR7x, STR9x, SWM050, TI CC13xx, TI CC26xx, TI CC32xx, TI MSP432, Winner Micro w600, Xilinx XCF, XMC1xxx, XMC4xxx. -# Building OpenOCD +## Building OpenOCD The INSTALL file contains generic instructions for running `configure` and compiling the OpenOCD source code. That file is provided by @@ -214,12 +216,12 @@ the GNU autotools, then you should read those instructions first. Note: if the INSTALL file is not present, it means you are using the source code from a development branch, not from an OpenOCD release. In this case, follow the instructions 'Compiling OpenOCD' below and -the file will be created by the first command './bootstrap'. +the file will be created by the first command `./bootstrap`. The remainder of this document tries to provide some instructions for those looking for a quick-install. -## OpenOCD Dependencies +### OpenOCD Dependencies GCC or Clang is currently required to build OpenOCD. The developers have begun to enforce strict code warnings (-Wall, -Werror, -Wextra, @@ -236,7 +238,7 @@ You'll also need: - pkg-config >= 0.23 or pkgconf - libjim >= 0.79 -Additionally, for building from git: +Additionally, for building from Git: - autoconf >= 2.69 - automake >= 1.14 @@ -244,9 +246,8 @@ Additionally, for building from git: Optional USB-based adapter drivers need libusb-1.0. -Optional USB-Blaster, ASIX Presto and OpenJTAG interface adapter -drivers need: - - libftdi: http://www.intra2net.com/en/developer/libftdi/index.php +Optional USB-Blaster, ASIX Presto and OpenJTAG interface adapter drivers need +[libftdi](http://www.intra2net.com/en/developer/libftdi/index.php) library. Optional CMSIS-DAP adapter driver needs HIDAPI library. @@ -279,46 +280,47 @@ For parport adapters on Windows you need to run install_giveio.bat (it's also possible to use "ioperm" with Cygwin instead) to give ordinary users permissions for accessing the "LPT" registers directly. -## Compiling OpenOCD +### Compiling OpenOCD To build OpenOCD, use the following sequence of commands: - ./bootstrap - ./configure [options] - make - sudo make install +```sh +./bootstrap +./configure [options] +make +sudo make install +``` -The `bootstrap` command is only necessary when building from the Git repository. The `configure` step generates the Makefiles required to build -OpenOCD, usually with one or more options provided to it. The first -'make' step 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. +The `bootstrap` command is only necessary when building from the Git repository. +The `configure` step generates the Makefiles required to build OpenOCD, usually +with one or more options provided to it. +The first 'make' step 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. To see the list of all the supported options, run `./configure --help` -## Cross-compiling Options +### Cross-compiling Options Cross-compiling is supported the standard autotools way, you just need to specify the cross-compiling target triplet in the --host option, e.g. for cross-building for Windows 32-bit with MinGW on Debian: - ./configure --host=i686-w64-mingw32 [options] - -To make pkg-config work nicely for cross-compiling, you might need an -additional wrapper script as described at +```sh +./configure --host=i686-w64-mingw32 [options] +``` - https://autotools.io/pkgconfig/cross-compiling.html +To make pkg-config work nicely for cross-compiling, you might need an additional +wrapper script as described at <https://autotools.io/pkgconfig/cross-compiling.html>. This is needed to tell pkg-config where to look for the target libraries that OpenOCD depends on. Alternatively, you can specify `*_CFLAGS` and `*_LIBS` environment variables directly, see `./configure --help` for the details. -For a more or less complete script that does all this for you, see +For a more or less complete script that does all this for you, see `contrib/cross-build.sh`. - contrib/cross-build.sh - -## Parallel Port Dongles +### Parallel Port Dongles If you want to access the parallel port using the PPDEV interface you have to specify both `--enable-parport` and `--enable-parport-ppdev`, since @@ -329,31 +331,28 @@ use both the `--enable-parport` and the `--enable-parport-giveio` option if you want to use giveio instead of ioperm parallel port access method. +### Obtaining OpenOCD From Git -# Obtaining OpenOCD From GIT - -You can download the current GIT version with a GIT client of your -choice from the main repository: - - git://git.code.sf.net/p/openocd/code +You can download the current Git version with a Git client of your +choice from the main repository: `git://git.code.sf.net/p/openocd/code` You may prefer to use a mirror: - http://repo.or.cz/r/openocd.git - git://repo.or.cz/openocd.git +- <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 +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://git.code.sf.net/p/openocd/code openocd +```sh +git clone git://git.code.sf.net/p/openocd/code openocd +``` Then you can update that at your convenience using `git pull`. -There is also a gitweb interface, which you can use either to browse -the repository or to download arbitrary snapshots using HTTP: - - http://repo.or.cz/w/openocd.git +There is also a gitweb interface, which you can use either to browse the +repository or to download arbitrary snapshots using HTTP: <http://repo.or.cz/w/openocd.git>. Snapshots are compressed tarballs of the source tree, about 1.3 MBytes each at this writing. --
