- Added coding style to README

[openocd] / README

diff --git a/README b/README
index 588f3ea632c6f221eabfd287f7c570b3cc8070f0..0d0a7e2b3204d1533e4b1db347bcc97bb9551a93 100644 (file)
--- a/README
+++ b/README
@@ -29,6 +29,7 @@ The list of supported parallel port devices includes:
   * Ka-Ro TRITON starterkit II JTAG cable
   * Lattice parallel port JTAG cable
   * ST FlashLINK programming cable
+  * Wiggler 2 cable (basically a wiggler with an LED)
 
 - The Amontec JTAG Accelerator. This is a configuration for Amontec's Chameleon
 dongle, a parallel port interface based on a Xilinx CoolRunner CPLD. It uses
@@ -75,9 +76,12 @@ The Signalyzer offers support for a wide variety of target voltages from 1.2V to
 Another USB JTAG programmer, with freely available schematics. It supports
 target voltages from 1.65V to 5.5V.
 
-* Hitex STR9-comSTICK: http://www.ehitex.de/p_info.php?products_id=292
+* Hitex STR9-comStick: http://www.ehitex.de/p_info.php?products_id=292
 A STR912FW44x microcontroller "board" with USB and JTAG functionality.
 
+* Hitex STM32-PerformanceStick: http://www.hitex.com/stm32-stick/
+A STM32F103RBT6 microcontroller "board" with USB and JTAG functionality.
+
 * Luminary Micro development board evb_lm3s811 JTAG interface.
 
 * ASIX PRESTO: http://www.asix-tools.com/prg_presto.htm
@@ -88,6 +92,8 @@ microcontrollers, serial EEPROM and Flash memory chips, CPLDs and others.
 The usbprog is a freely programmable USB adapter, which can (among other
 things) use a firmware which turns it into a JTAG programmer/debugger.
 
+* Altium universal JTAG cable
+
 All FT2232 based devices may be accessed using either FTDI's proprietary FTD2XX
 library (www.ftdichip.com) or using an open-source replacement from
 http://www.intra2net.com/de/produkte/opensource/ftdi/index.php, also included
@@ -112,7 +118,7 @@ Support for Intel XScale CPUs is also included:
 - IXP42x
 
 And support for the Marvell Feroceon CPU core as found in the
-Orion SOC family is included as well.
+Orion SoC family is included as well.
 
 3. Host platforms
 
@@ -125,7 +131,40 @@ AMD64-Linux, Alpha-Linux, ARM-Linux, and PowerPC OS-X.
 Documentation for the OpenOCD is hosted in the Berlios OpenFacts Wiki at
 http://openfacts.berlios.de/index-en.phtml?title=Open_On-Chip_Debugger.
 
-5. Licensing
+There is also and openocd(1) manpage, the 'openocd --help' output and
+an OpenOCD info page (type 'info openocd').
+
+5. Coding Style
+
+The following rules try to describe formatting and naming conventions that 
+should be followed to make the whole OpenOCD code look more consistent.
+The ultimate goal of coding style should be readability, and these rules may 
+be ignored for a particular (small) piece of code if that makes it more 
+readable.
+
+Formatting rules:
+- remove any trailing white space
+- use TAB characters for indentation, not spaces
+- displayed TAB width is 4 characters
+- make sure NOT to use DOS '\r\n' line feeds
+- do not add more than 2 empty lines to source files
+- do not add trailing empty lines to source files
+- do not use C++ style comments (//)
+- lines may be reasonably wide - there's no anachronistic 80 characters limit
+
+Naming rules:
+- identifiers use lower-case letters only
+- identifiers consisting of multiple words use underline characters between 
+consecutive words
+- macros use upper-case letters only
+- structure names shall be appended with '_s'
+- typedefs shall be appended with '_t'
+
+Function calls:
+- function calls have no space between the functions name and the parameter 
+list: my_func(param1, param2, ...)
+
+6. Licensing
 
 OpenOCD is licensed under the terms of the GNU General Public License, see the
 file COPYING for details.