Re: [Openocd-development] SVF to XSVF Converter, and Patches

[Rick Altherr]

On Dec 12, 2008, at 10:11 AM, Spencer Oliver wrote:

As far as I can tell, there is no established standard.  I

would love

to institute one.

There was a basic standard, it seems to have vanished from the README

basically follow the format of the existing source, use tabs
not spaces.
we will have to clarify a spec if we cannot find the old one.

This is from the old readme - needs adding to the docs gain

5. Coding Style




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 (//)

limit

Naming rules:
- identifiers use lower-case letters only

consecutive words
- macros use upper-case letters only
- structure names shall be appended with '_s'
- typedefs shall be appended with '_t'

Function calls:

list: my_func(param1, param2, ...)

Cheers
Spen

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 - lines may be reasonably wide - there's no anachronistic 80 characters - identifiers consisting of multiple words use underline characters between - function calls have no space between the functions name and the parameter

--
Rick Altherr
kc8...@kc8apf.net


 -- Unsigned

It would be great if someone drafted a config file for uncrustify that we could run periodically. I played with that a bit tonight, but the sheer number of options made my eyes bug out. I'll stick to making code improvements. "He said he hadn't had a byte in three days. I had a short, so I split it with him."

smime.p7s
Description: S/MIME cryptographic signature

_______________________________________________
Openocd-development mailing list
Openocd-development@lists.berlios.de
https://lists.berlios.de/mailman/listinfo/openocd-development