X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3c8feb27df205372a67f1230e4038b30c38d0f3d..9cd192ac127fe76be50a32502c1fb13d5847fa71:/README.coding diff --git a/README.coding b/README.coding index 4183390cc8..a5c9b96484 100644 --- a/README.coding +++ b/README.coding @@ -23,24 +23,15 @@ The tree is not split on projects, but on file finality: src/include -> another location for protected headers. Used by SURF, and other should be converted, since this is the Right Thing. - testsuite/ -> The more test the better. - Same organization than src/ and include/ - Tests are allowed to load some headers of the module they test. - All tests should be listed in run_test.in so that they get - run on 'make check'. - 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. + 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. ** ** Indentation standard @@ -92,7 +83,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 +93,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 between 32 bits and 64 bits archs. Either use plain ints (generally + 32 bits wide) or long long ints (64 bits wide, at least). At last resort + consider using integer types defined in C99 by . + PRINTF pointer difference (FIXME: advertise %td instead?) printf ("diff = %ld\n", (long) (pointer2 - pointer1)); @@ -187,6 +184,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 @@ -204,4 +205,3 @@ 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