X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/49e85177c669d793e84242983a1b1f430e47184e..0b434542d7de83f5e040e7c03d5e98cd9c9f5d8a:/README.coding diff --git a/README.coding b/README.coding index c78b39b68c..4dd9610f2d 100644 --- a/README.coding +++ b/README.coding @@ -3,13 +3,18 @@ ** ****************************************************** -There is at least 4 sub-projects in the tree: +There is at least 5 sub-projects in the tree: - XBT: eXtended Bundle of Tools (low-level toolbox: logging, datatypes). - SURF: a SimUlation aRtiFact. This is the simulation kernel. - MSG: originally MetaSimGrid, MSG is a simple distributed application simulator. - - SMPI: Simulated MPI, to run MPI application using emulation technics. + - SMPI: Simulated MPI, to run MPI application using emulation technics; + - MC: model-checker; + - SIMIX: basix interface for simulated processes. This layer defines simcalls + (simulation calls) exposed to the simulated processes by the SIMIX "kernel". + This interface is used to implement the MSG, SMPI layers. + - SIMDAG; They are all in the same tree because they are complementary tools and having all of them in the same package makes the installation easier @@ -23,12 +28,6 @@ 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. @@ -39,9 +38,6 @@ The tree is not split on projects, but on file finality: 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 ** @@ -50,11 +46,11 @@ The tree is not split on projects, but on file finality: Most files use the Kernighan & Ritchie coding style with 2 spaces of indentation. The indent program can help you to stick to it: -indent -kr -l80 -nut -i2 -lps -npcs -br -brs -ce -cdw -bbo -npsl +indent -kr -l120 -nut -i2 -lps -npcs -br -brs -ce -cdw -bbo -npsl -The script ./tools/indent runs indent with the appropriate options. +The script ./tools/internal/indent runs indent with the appropriate options. -FIXME: this list of arguments is still to be discussed, maybe +If you use Eclipse, please import the settings in ./tools/internal/eclipse-formating.xml ** ** Type naming standard @@ -111,12 +107,6 @@ INTEGERS PRINTF pointer difference (FIXME: advertise %td instead?) printf ("diff = %ld\n", (long) (pointer2 - pointer1)); -INLINE functions - The definition of a inline function must be visible when it is used. - As such, an inline function should be defined (an not only declared) - in header file (.h) with attributes 'static XBT_INLINE'. It should - not be defined in source file (.c). - ** ** Commenting the source: doxygen **