From: zwelch Date: Thu, 18 Jun 2009 07:11:55 +0000 (+0000) Subject: Update Style Guide documentation to explain basic type rules. X-Git-Tag: v0.2.0~231 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=c5de7b6bd702e90bfd69d1c2efdd81713aefb191;p=openocd Update Style Guide documentation to explain basic type rules. git-svn-id: svn://svn.berlios.de/openocd/trunk@2284 b42882b7-edfa-0310-969c-e2dbd0fdcd60 --- diff --git a/doc/manual/style.txt b/doc/manual/style.txt index c6dc3ca2..b9a7612f 100644 --- a/doc/manual/style.txt +++ b/doc/manual/style.txt @@ -80,6 +80,13 @@ Finally, try to avoid lines of code that are longer than than 72-80 columns: - variables declarations may be mixed with code - new block scopes for selection and iteration statements +@section styletypes Type Guidelines +- use native types (@c int or @c unsigned) if the type is not important + - if size matters, use the types from \ or \: + - @c int8_t, @c int16_t, @c int32_t, or @c int64_t: signed types of specified size + - @c uint8_t, @c uint16_t, @c uint32_t, or @c uint64_t: unsigned types of specified size + - do @b NOT redefine @c uN types from "types.h" + @section stylefunc Functions - static inline functions should be prefered over macros: