Project

General

Profile

Guidelines » History » Version 19

Greg Burri, 11/18/2009 09:05 PM

1 1 Greg Burri
h1. Guidelines
2
3
h2. Documentation
4
5
* Use of ' when referencing a name like 'myVar'
6
* Use of " when referencing a value like "my string"
7
8 2 Greg Burri
h2. Coding
9 1 Greg Burri
10 12 Greg Burri
See the prototypes for code reference : source:/prototypes.
11 5 Greg Burri
12 13 Greg Burri
h3. Some random rules
13
14
* Try to minimize the use of dynamic allocation. Use constructor initializer to set non-pointer members.
15
* Use parameter references variable passing instead of pointers.
16
* Always have the design pattern "RAII":http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization in mind.
17 18 Greg Burri
* Avoid exception specification, see : http://www.ddj.com/architect/184401544
18 13 Greg Burri
19 5 Greg Burri
h2. Version number
20
21 14 Greg Burri
A version number has three numbers plus a tag and some other information :
22
_<a>.<b>.<c> <tag> <date+time> <tree hash>_
23 5 Greg Burri
24
_<a>_ : Major version
25
_<b>_ : Evolution
26 1 Greg Burri
_<c>_ : Revision (bugfixes)
27 19 Greg Burri
_<tag>_ : alpha | beta<num> | <nothing>
28 14 Greg Burri
_<date+time>_ : Date and time of the built tree, for example : _2009-08-01 17:42Z_. See "ISO8601":http://en.wikipedia.org/wiki/ISO_8601
29 17 Greg Burri
_<tree hash>_ : The hash of the built tree, for example : "b53118220bb28abf649df43fc144cc21919b512e":http://git.euphorik.ch/index.cgi?p=aybabtu.git;a=tree;h=b53118220bb28abf649df43fc144cc21919b512e
30 5 Greg Burri
31 14 Greg Burri
For example (date, time and hash are omitted)  :
32 1 Greg Burri
* _1.0 alpha_ (first version)
33 19 Greg Burri
* _1.0 beta1_
34
* _1.0 beta2_
35
* _1.0 beta3_
36 7 Greg Burri
* *_1.0_* (stable version)
37 11 Greg Burri
* _1.0.1_ (first revision)
38 7 Greg Burri
* _1.0.2_ (second revision)
39
* _1.1 alpha_ (first evolution)
40 5 Greg Burri
* _1.1 beta_
41 6 Greg Burri
* *_1.1_*
42 5 Greg Burri
* _1.1.1_
43
* etc..
44 8 Greg Burri
45
h3. Beta and alpha versions
46
47
The alpha is a development version not yet finished only for developers.
48 9 Greg Burri
The beta is an almost released version that can be public.
49 15 Greg Burri
50
Only Alpha versions are built in Debug with full log enabled. All other versions are built in release mode.