Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add some words about integer typesi in README.coding.
[simgrid.git] / README.coding
index 4183390..f03cc78 100644 (file)
@@ -92,7 +92,7 @@ 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.
 
@@ -102,6 +102,12 @@ SIZE_T (FIXME: obsolete?)
  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));
 
@@ -187,6 +193,10 @@ investigating the portability of the thing to windows.
 * 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