X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9e68ca10e951fb61e944c99c7774b1e415ae9f6d..53a5eb4773ed7bf9df12d0be7781a0e70b458e04:/README.coding

diff --git a/README.coding b/README.coding
index a2ea54f742..f03cc78b23 100644
--- a/README.coding
+++ b/README.coding
@@ -32,6 +32,16 @@ The tree is not split on projects, but on file finality:
  examples/ -> Supposed to be copy/pastable by the user, so keep it clear and
                 avoid any kind of trick. In particular, do only include the
                 public headers here.
+
+ teshsuite/ -> The more test the better. Put in there any strange test
+	       doing things that the users are not supposed to do,
+	       just to see if our framework is robust to incorrect and
+	       unusual behaviors. All tests written in this section
+	       should leverage our tesh(1) utility.
+ 
+ testsuite/ -> Old test suite, that should be converted to tesh and
+               moved to teshsuite at some point.
+
 **
 ** Indentation standard
 **
@@ -82,14 +92,21 @@ bug. Please report it (or fix it yourself if you can).
 **
 *****************************************************
 
-MALLOC:
+MALLOC
  Don't use it, or you'll have to check the result (and do some dirty stuff
  on AIX). Use xbt_malloc (or even better, xbt_new) instead.
 
 SIZE_T (FIXME: obsolete?)
  If possible, avoid size_t and use unsigned long instead. If not,
  #include <sys/types.h> in all files manipulating size_t
- do cast it to unsigned long before printing (and use %lu)
+ do cast it to unsigned long before printing (and use %lu),
+ or use %zu.
+
+INTEGERS
+ Please avoid to use long ints.  This is the source of many compatibility
+ problems betwwen 32 bits and 64 bits archs.  Either use plain ints (generally
+ 32 bits width) or long long ints (64 bits width, at least).  At last resort
+ consider using integer types defined in C99 by <stdint.h>.
 
 PRINTF pointer difference (FIXME: advertise %td instead?)
  printf ("diff = %ld\n", (long) (pointer2 - pointer1));
@@ -173,6 +190,13 @@ investigating the portability of the thing to windows.
       cmake -Denable_compile_optimizations=ON \
             -Denable_compile_warnings=ON
 
+* Your commit message should follow the git habits, explained eg here:
+  http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+
+* When you add/remove files, and/or make changes in the lists of files to build,
+  please check that "make distcheck" still succeeds.  This is needed to ensure
+  that the generated archive is consistent.
+
 * If you want to debug memory allocation problems, here are a few hints:
   - disable compiler optimizations, to have better backtraces;
   - disable the mallocators, or it will be hard to match malloc's with
@@ -190,3 +214,4 @@ investigating the portability of the thing to windows.
   deactivate the whole logging mechanism, switching to printfs
   instead. SimGrid becomes incredibly verbose when doing so, but it
   you let you fixing the dynars.
+  
\ No newline at end of file