]> Creatis software - gdcm.git/blob - Doc/Website/Developpers.html
* Added Doc/Website/CodingStyle.html, Developpers.html,
[gdcm.git] / Doc / Website / Developpers.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <HTML>
3 <HEAD>
4    <META http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
5    <TITLE>Gdcm Developpers</TITLE>
6 </HEAD>
7
8 <BODY>
9
10 <!#######################################################################>
11 <H1>Gdcm Developpers</H1>
12 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
13
14 First you should be familiar on how to 
15 <A HREF="Installation.html">recompile, install and test</A>
16 gdcm from the
17 <A HREF="Cvs.html">sources obtained with cvs</A>.
18 <BR>
19 <!##############################>
20 Please adopt the
21 <A HREF="CodingStyle.html"><B>coding style</B></A>.
22 <BR>
23 <!##############################>
24 <H3>CVS policy</H3>
25 <UL>
26 <LI>All the commits should be atomic. They must preserve the compilation
27   in order to prevent checkouts with broken code.
28 </LI>
29 <LI> All the commits must correspond to a state of the code where ctest
30   runs and has no failing subtest. Always run ctest before commiting.
31   <BR>
32   <B>Notes</B>:
33   <UL>
34   <LI> you can start ctest in verbose mode through the command
35      <TT>ctest -V >& log</TT>
36   </LI>
37   <LI> you can start a single test through ctest with
38       ctest -R FailingTestName -V >& log
39   </LI>
40   </UL>
41 </LI>
42 </UL>
43
44 <!##############################>
45 <H3>Compiler flags policy</H3>
46 When working with gcc please use the following flags when
47 configuring the cmake variable <TT>CMAKE_CXX_FLAGS</TT>
48 <BR>
49 <TT>-g -O0 -Wall -W -Wshadow -Wunused-variable -Wunused-parameter
50          -Wunused-function -Wunused -Wno-system-headers -Wno-deprecated
51          -Woverloaded-virtual
52 </TT>
53
54 <!##############################>
55 <H3>Sending the result to kitware's dashboard (optional)</H3>
56 Use <TT>ctest -D Experimental</TT>.
57 <BR>
58 The results should appear in
59 <A HREF="http://public.kitware.com/dashboard.php?name=public">
60         Kitware's dashboard</A>
61 under the name of your machine (uname). For ease of use you can
62 change the SITE variable in your CMakeCache.txt to something more
63 accurate such as: GDCM-my_machine_name. The entry will then be within
64 the "Experimental Builds" entry.
65
66
67 <!#######################################################################>
68 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
69
70 </BODY>
71 </HTML>