From 8aaf612c0175ea07b478f13cdbd1d86b52d2cb12 Mon Sep 17 00:00:00 2001 From: alegrand Date: Fri, 10 Mar 2006 15:24:12 +0000 Subject: [PATCH 1/1] Adding a contrib section to the doc git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@1935 48e7efb5-ca39-0410-a469-dd3cf9ba447f --- doc/Doxyfile.in | 1 + doc/Makefile.am | 6 ++--- doc/contrib.doc | 26 +++++++++++++++++++ doc/simgrid_modules.fig | 57 +++++++++++++++++++++++------------------ 4 files changed, 62 insertions(+), 28 deletions(-) create mode 100644 doc/contrib.doc diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 3d2a899b7b..430d67f16e 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -396,6 +396,7 @@ WARN_LOGFILE = INPUT = @srcdir@/index.doc \ @srcdir@/FAQ.doc \ + @srcdir@/contrib.doc \ @srcdir@/publis.doc \ ./index-API.doc \ \ diff --git a/doc/Makefile.am b/doc/Makefile.am index c1a9891ccd..4acd8230ea 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -2,7 +2,7 @@ DOCSOURCES = $(shell find @top_srcdir@/tools/gras @top_srcdir@/src @top_srcdir@ $(shell find @srcdir@ -name "*.doc") EXTRA_DIST = html Doxyfile \ - modules.doc FAQ.doc index.doc publis.doc footer.html simgrid_logo.png simgrid_modules.png + modules.doc FAQ.doc contrib.doc index.doc publis.doc footer.html simgrid_logo.png simgrid_modules.png CLEANFILES = .*.toc DISTCLEANFILES = index-API.doc simgrid.tag @@ -20,7 +20,7 @@ simgrid_modules.png: simgrid_modules.fig html: Doxyfile ./logcategories.doc simgrid_modules.map simgrid_modules.png $(DOCSOURCES) : # Setting up - touch index-API.doc .FAQ.doc.toc .index.doc.toc + touch index-API.doc .FAQ.doc.toc .index.doc.toc .contrib.doc.toc test -e html || mkdir html cp @srcdir@/simgrid_logo.png @srcdir@/simgrid_modules.png html/ cp @srcdir@/Paje_MSG_screenshot_thn.jpg @srcdir@/Paje_MSG_screenshot.jpg html/ @@ -28,7 +28,7 @@ html: Doxyfile ./logcategories.doc simgrid_modules.map simgrid_modules.png $(DOC : # First pass doxygen Doxyfile >/dev/null @top_srcdir@/tools/doxygen/index_create.pl simgrid.tag index-API.doc - @top_srcdir@/tools/doxygen/toc_create.pl @srcdir@/FAQ.doc @srcdir@/index.doc + @top_srcdir@/tools/doxygen/toc_create.pl @srcdir@/FAQ.doc @srcdir@/index.doc @srcdir@/contrib.doc : # Second pass doxygen Doxyfile >/dev/null : # Post-processing diff --git a/doc/contrib.doc b/doc/contrib.doc new file mode 100644 index 0000000000..4f5afd8994 --- /dev/null +++ b/doc/contrib.doc @@ -0,0 +1,26 @@ +/*! \page contrib Contrib section + +\htmlinclude .contrib.doc.toc + +\section contrib_intro A contrib section ? Why ? + +Many people have come to ask us more complex examples than the simple ones +that are distributed with the main branch of the SimGrid project. We do not +want to include complex examples in the main branch but we think it is a +good idea that users share their experience. That is why we have created a +contrib branch that can be used by people who have a nice piece of work +using SimGrid and accept to share it. The licence of this code should be +LGPL if possible. If you can't licence your code with LGPL, just tell us +about it and we will try to sort out whether it makes sense to publish it +here. + +\section contrib_surf Projects relying on SURF +\section contrib_msg Projects relying on MSG +\section contrib_gras Projects relying on GRAS +\section contrib_smpi Projects relying on SMPI + +\author Arnaud Legrand (arnaud.legrand::imag.fr) +\author Martin Quinson (martin.quinson::loria.fr) + +*/ + diff --git a/doc/simgrid_modules.fig b/doc/simgrid_modules.fig index 1ffc8d9efc..3d21324932 100644 --- a/doc/simgrid_modules.fig +++ b/doc/simgrid_modules.fig @@ -12,25 +12,25 @@ Single 0 34 #adbeff 0 35 #ff4952 0 36 #a5a6a5 +0 37 #ff9700 6 -1215 945 7290 1665 2 2 0 1 0 31 60 -1 20 0.000 0 0 -1 0 0 5 -1215 1665 7290 1665 7290 945 -1215 945 -1215 1665 -4 1 0 50 -1 4 14 0.0000 2 180 1170 3037 1380 User Code\001 +4 1 0 50 -1 4 14 0.0000 2 165 1155 3037 1380 User Code\001 -6 6 3555 2205 4590 2835 # href="group__AMOK__API.html" ALT="AMOK" 2 2 0 1 0 27 60 -1 20 0.000 0 0 -1 0 0 5 3577 2205 4567 2205 4567 2835 3577 2835 3577 2205 -4 1 0 50 -1 4 12 0.0000 2 165 675 4072 2745 toolbox\001 -4 1 0 50 -1 4 14 0.0000 2 180 720 4072 2475 AMOK\001 +4 1 0 50 -1 4 12 0.0000 2 150 630 4072 2745 toolbox\001 +4 1 0 50 -1 4 14 0.0000 2 165 720 4072 2475 AMOK\001 +-6 +6 4590 1035 6840 1530 +# href="contrib.html" ALT="Contrib" +2 2 0 1 0 37 55 -1 20 0.000 0 0 -1 0 0 5 + 4590 1530 6840 1530 6840 1035 4590 1035 4590 1530 +4 1 0 50 -1 4 14 0.0000 2 165 780 5715 1365 Contrib\001 -6 -# href="group__XBT__API.html" ALT="XBT" -2 3 0 1 0 33 60 -1 20 0.000 0 0 -1 0 0 7 - -765 2205 -1215 2205 -1215 5400 7290 5400 7290 4500 -765 4500 - -765 2205 -# href="group__SURF__API.html" ALT="SMPI" -2 2 0 1 0 34 60 -1 20 0.000 0 0 -1 0 0 5 - -675 3510 7290 3510 7290 4365 -675 4365 -675 3510 # href="group__GRAS__API.html" ALT="GRAS" 2 3 0 1 0 35 50 -1 20 0.000 0 0 -1 0 0 7 4590 3375 4590 2925 3510 2925 3510 2205 2025 2205 2025 3375 @@ -41,18 +41,25 @@ Single # href="group__SMPI__API.html" ALT="SMPI" 2 2 0 1 0 36 60 -1 20 0.000 0 0 -1 0 0 5 4725 2205 7290 2205 7290 3375 4725 3375 4725 2205 -4 1 0 50 -1 4 12 0.0000 2 210 8595 3037 5115 Grounding features (logging, etc.), usual data structures (lists, sets, etc.) and portability layer\001 -4 1 0 50 -1 4 12 0.0000 2 210 2280 3307 4102 virtual platform simulator\001 -4 1 0 50 -1 4 12 0.0000 2 210 2025 6030 2955 applications on top of\001 -4 1 0 50 -1 4 12 0.0000 2 165 1965 6030 3210 a virtual environment\001 -4 1 0 50 -1 4 14 0.0000 2 180 480 3037 4860 XBT\001 -4 1 0 50 -1 4 14 0.0000 2 180 675 3307 3847 SURF\001 -4 1 0 50 -1 4 14 0.0000 2 180 705 2745 2475 GRAS\001 -4 1 0 50 -1 4 12 0.0000 2 165 1050 2745 2745 Framework\001 -4 1 0 50 -1 4 12 0.0000 2 210 1050 2745 2970 to develop\001 -4 1 0 50 -1 4 14 0.0000 2 180 555 607 2520 MSG\001 -4 1 0 50 -1 4 12 0.0000 2 210 1770 607 2835 Simple application-\001 -4 1 0 50 -1 4 12 0.0000 2 165 1335 607 3105 level simulator\001 -4 1 0 50 -1 4 14 0.0000 2 180 585 6030 2520 SMPI\001 -4 1 0 50 -1 4 12 0.0000 2 210 1680 6030 2745 Library to run MPI\001 -4 1 0 50 -1 4 12 0.0000 2 210 2205 3195 3195 distributed applications\001 +# href="group__SURF__API.html" ALT="SMPI" +2 2 0 1 0 34 60 -1 20 0.000 0 0 -1 0 0 5 + -675 3510 7290 3510 7290 4365 -675 4365 -675 3510 +# href="group__XBT__API.html" ALT="XBT" +2 3 0 1 0 33 60 -1 20 0.000 0 0 -1 0 0 7 + -765 2205 -1215 2205 -1215 5400 7290 5400 7290 4500 -765 4500 + -765 2205 +4 1 0 50 -1 4 12 0.0000 2 195 8085 3037 5115 Grounding features (logging, etc.), usual data structures (lists, sets, etc.) and portability layer\001 +4 1 0 50 -1 4 12 0.0000 2 195 2145 3307 4102 virtual platform simulator\001 +4 1 0 50 -1 4 12 0.0000 2 195 1860 6030 2955 applications on top of\001 +4 1 0 50 -1 4 12 0.0000 2 150 1815 6030 3210 a virtual environment\001 +4 1 0 50 -1 4 14 0.0000 2 165 480 3037 4860 XBT\001 +4 1 0 50 -1 4 14 0.0000 2 165 675 3307 3847 SURF\001 +4 1 0 50 -1 4 14 0.0000 2 165 705 2745 2475 GRAS\001 +4 1 0 50 -1 4 12 0.0000 2 150 960 2745 2745 Framework\001 +4 1 0 50 -1 4 12 0.0000 2 195 960 2745 2970 to develop\001 +4 1 0 50 -1 4 14 0.0000 2 165 555 607 2520 MSG\001 +4 1 0 50 -1 4 12 0.0000 2 195 1650 607 2835 Simple application-\001 +4 1 0 50 -1 4 12 0.0000 2 150 1260 607 3105 level simulator\001 +4 1 0 50 -1 4 14 0.0000 2 165 585 6030 2520 SMPI\001 +4 1 0 50 -1 4 12 0.0000 2 195 1560 6030 2745 Library to run MPI\001 +4 1 0 50 -1 4 12 0.0000 2 195 2055 3195 3195 distributed applications\001 -- 2.20.1