OpenOCD
OpenOCD Documentation Primers

This page provides an introduction to OpenOCD's documentation processes.

OpenOCD presently produces several kinds of documentation:

  • The User's Guide:
    • Focuses on using the OpenOCD software.
    • Details the installation, usage, and customization.
    • Provides descriptions of public Jim/TCL script commands.
    • Written using GNU texinfo.
    • Created with 'make pdf' or 'make html'.
    • See Texinfo Primer and Texinfo Style Guide.
  • The References: (as proposed)
    • Focuses on using specific hardware with OpenOCD.
    • Details the supported interfaces, chips, boards, and targets.
    • Provides overview, usage, reference, and FAQ for each device.
    • Written using LaTeX language with custom macros.
    • Created with 'make references'.
    • See LaTeX Primer and LaTeX Style Guide.
  • The Manual:
    • Focuses on developing the OpenOCD software.
    • Details the architecture, driver interfaces, and processes.
    • Provides "full" coverage of C source code (work-in-progress).
    • Written using Doxygen C language conventions (i.e. in comments).
    • Created with 'make doxygen'.
    • See Doxygen Primer and Doxygen Style Guide.

The following sections provide more information for anyone that wants to contribute new or updated documentation to the OpenOCD project.