From 6954c93e08236323ccf19a1a426883eb27bead54 Mon Sep 17 00:00:00 2001 From: Jan Beulich Date: Wed, 7 Aug 2019 12:08:38 +0200 Subject: [PATCH] CODING_STYLE: document intended usage of types Signed-off-by: Jan Beulich Acked-by: George Dunlap --- CODING_STYLE | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CODING_STYLE b/CODING_STYLE index 6cc5b774cf..810b71c16d 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -88,6 +88,19 @@ Braces should be omitted for blocks with a single statement. e.g., if ( condition ) single_statement(); +Types +----- + +Use basic C types and C standard mandated typedef-s where possible (and +with preference in this order). This in particular means to avoid u8, +u16, etc despite those types continuing to exist in our code base. +Fixed width types should only be used when a fixed width quantity is +meant (which for example may be a value read from or to be written to a +register). + +Especially with pointer types, whenever the pointed to object is not +(supposed to be) modified, qualify the pointed to type with "const". + Comments -------- -- 2.30.2