diff options
| author | zwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60> | 2009-06-18 07:11:55 +0000 |
|---|---|---|
| committer | zwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60> | 2009-06-18 07:11:55 +0000 |
| commit | c5de7b6bd702e90bfd69d1c2efdd81713aefb191 (patch) | |
| tree | fcc68dbfc1d3d7d64b5ea9ecba77372529670a6c /doc | |
| parent | 4cf8d5ec177dd05919a5a5eb32625bf7a4a3bb3f (diff) | |
| download | openocd_libswd-c5de7b6bd702e90bfd69d1c2efdd81713aefb191.tar.gz openocd_libswd-c5de7b6bd702e90bfd69d1c2efdd81713aefb191.tar.bz2 openocd_libswd-c5de7b6bd702e90bfd69d1c2efdd81713aefb191.tar.xz openocd_libswd-c5de7b6bd702e90bfd69d1c2efdd81713aefb191.zip | |
Update Style Guide documentation to explain basic type rules.
git-svn-id: svn://svn.berlios.de/openocd/trunk@2284 b42882b7-edfa-0310-969c-e2dbd0fdcd60
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/style.txt | 7 |
1 files changed, 7 insertions, 0 deletions
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 \<stdint.h\> or \<inttypes.h\>: + - @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: |