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 <!#######################################################################>
  15 <A HREF="http://public.kitware.com/dashboard.php?name=gdcm">
  16 DashBoard</A> (look for a "Build Name" containing GDCM)
  17 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
  18
  19 <!#######################################################################>
  20 First you should be familiar on how to
  21 <A HREF="Installation.html">recompile, install and test</A>
  22 gdcm from the
  23 <A HREF="Cvs.html">sources obtained with cvs</A>.
  24 <BR>
  25 <!##############################>
  26 Please adopt the
  27 <A HREF="CodingStyle.html"><B>coding style</B></A>.
  28 <BR>
  29 <!##############################>
  30 <H3>CVS policy</H3>
  31 <UL>
  32 <LI>All the commits should be atomic. They must preserve the compilation
  33   in order to prevent checkouts with broken code.
  34 </LI>
  35 <LI> All the commits must correspond to a state of the code where ctest
  36   runs and has no failing subtest. <b>Always</b> run ctest before commiting.
  37   <BR>
  38   <B>Notes</B>:
  39   <UL>
  40   <LI> you can start ctest in verbose mode through the command
  41      <TT>ctest -V >& log</TT>
  42   </LI>
  43   <LI> you can start a single test through ctest with
  44       ctest -R FailingTestName -V >& log
  45   </LI>
  46   </UL>
  47 </LI>
  48 </UL>
  49
  50 <!##############################>
  51 <H3>Compiler flags policy</H3>
  52 When working with gcc, please use the following flags when
  53 configuring the cmake variable <TT>CMAKE_CXX_FLAGS</TT>
  54 As a side not if you have proper bash/zsh setup cmake automatically
  55 inspect your CFLAGS and CXXFLAGS. So you can set them up for any
  56 project. <b>Be carefull</b> though, the quality of your code will greatly
  57 improve by doing so.
  58 <BR>
  59 For CFLAGS:
  60 <TT> -Wall -W
  61 </TT>
  62 For CXXFLAGS:
  63 <TT> -Wall -W -Wshadow -Wunused -Wno-system-headers -Wno-deprecated
  64      -Woverloaded-virtual
  65 </TT>
  66 For paranoid people, or simply beginner you can also try to compiler gdcm
  67 using the -pedantic flags compiler option.
  68
  69 <!##############################>
  70 <H3>Sending the result to kitware's dashboard (optional)</H3>
  71 Use <TT>ctest -D Experimental</TT>.
  72 <BR>
  73 The results should appear in
  74 <A HREF="http://public.kitware.com/dashboard.php?name=gdcm">
  75         Kitware's dashboard</A>
  76 under the name of your machine (uname). For ease of use you can
  77 change the BUILDNAME variable in your CMakeCache.txt to something more
  78 accurate such as: GDCM-my_machine_name. The entry will then be within
  79 the "Experimental Builds" entry.
  80 <b>UPDATE:</b>Since GDCM moved to its own dashboard there is no possble
  81 collision with other project. You can then send dashboard without having
  82 to properly prepend 'GDCM-' to your cmake BUILDNAME variable. But the
  83 Win32, mingw, gcc, SunOS is still very important...
  84
  85
  86
  87 <!#######################################################################>
  88 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
  89
  90 </BODY>
  91 </HTML>