Style Guides

The goals for each of these guides are:

• to produce correct code that appears clean, consistent, and readable,
• to allow developers to create patches that conform to a standard, and
• to eliminate these issues as points of future contention.

Some of these rules may be ignored in the spirit of these stated goals; however, such exceptions should be fairly rare.

The following style guides describe a formatting, naming, and other conventions that should be followed when writing or changing the OpenOCD code:

• TCL Style Guide
• C Style Guide
• Perl Style Guide
• Autotools Style Guide

In addition, the following style guides provide information for providing documentation, either as part of the C code or stand-alone.

• Doxygen Style Guide
• Texinfo Style Guide
• LaTeX Style Guide

Feedback would be welcome to improve the OpenOCD guidelines.