comparison gpf/TEMPLATE/PEI/crules.txt @ 0:509db1a7b7b8

initial import: leo2moko-r1
author Space Falcon <falcon@ivan.Harhan.ORG>
date Mon, 01 Jun 2015 03:24:05 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:509db1a7b7b8
1 C-Rules and and the Pei-Templates
2 =================================
3
4 This file contains some remarks to the C programming rules
5 and how they are applied in the pei template files xxx_pei.c,
6 xxx.h, (and mon_xxx.h).
7
8 - xxx_pei.c contains a prototype definition for a static function.
9 This is permitted (e.g. to avoid warnings), but not mandatory.
10
11 - #define for compiler switches (e.g. '#define ENTITY_XXX' in xxx_pei.c)
12 usually appear before the "sections", like INCLUDES, CONSTS, TYPES,...
13
14 - T_QMSG is a structure written before the C Coding Standard was in force.
15 Therefore, its members don't diverge from the rules about names.
16
17 - ClearCase - in contrast to some other versioning systems - does not
18 support default string replacements like $Version:$ in the controlled files.
19 Nevertheless it is possible to apply a self-written function that inserts
20 an identification string in the files. This function usually is not
21 called on each checkin, but e.g. for a delivery. The string $Identity:$
22 in the header of the files is assigned for keeping this possibility.