From: Martin Quinson <martin.quinson@loria.fr>
Date: Thu, 19 May 2016 07:29:33 +0000 (+0200)
Subject: outline a page on high-level concepts to describe your platform
X-Git-Tag: v3_14~1207
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/5f07f1baf9e26173f15059d345fcd5bbb997dec3

outline a page on high-level concepts to describe your platform
---

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 65163a5c44..0d14f2aabf 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -644,8 +644,9 @@ WARN_LOGFILE           =
 
 INPUT                  = doxygen/index.doc \
                          doxygen/getting_started.doc \
-                         doxygen/tutorial.doc \
                          doxygen/install.doc \
+			 doxygen/application.doc \
+                         doxygen/tutorial.doc \
                          doxygen/examples.doc \
                            doxygen/platform.doc \
                            doxygen/deployment.doc \
diff --git a/doc/doxygen/application.doc b/doc/doxygen/application.doc
new file mode 100644
index 0000000000..d34891966e
--- /dev/null
+++ b/doc/doxygen/application.doc
@@ -0,0 +1,37 @@
+/** 
+@page app Describing your application
+
+TBD
+
+* Main concepts
+
+  - *Actor* (or process in legacy interfaces of SimGrid)
+  
+  - *Activities*: resource usage that applications do. This is what
+    takes time.
+    
+    Any given actor can do at most one foreground activity, while it
+    can also do several non-blocking activities in the background.
+    
+  - These activities take place on *Resources* (links, compute
+    machine, disks). Resources should be described (created) in the
+    Virtual Platform (link), but your application have many other ways
+    to interact with the resource.  
+
+  - The resources are arranged in a hierarchy of *Autonomous Systems*,
+    with which the application can also interact. The AS knows the
+    networking path between one resource to another.
+
+Speak of mailboxes here? Where if not?
+
+* Interfaces to describe applications
+
+- Simple C++ interface: S4U that is currently designed
+- Simple Legacy C interfaces: MSG and SimDag, with comparison.
+- Simple Java Interface: Currently MSG-based, but will be replaced with S4U stuff when ready
+- MPI applications
+
+- Arbitrary applications: Simterpose and Remote SimGrid (they are currently far from being usable).
+- State our goal of BYOS (build your own simulator), even if it's just a neat name for now
+
+*/
\ No newline at end of file
diff --git a/doc/doxygen/index.doc b/doc/doxygen/index.doc
index 949b4f0c01..7f6f4fb1f9 100644
--- a/doc/doxygen/index.doc
+++ b/doc/doxygen/index.doc
@@ -11,7 +11,7 @@
 @endhtmlonly
 
 - @subpage getting_started
-  - @ref install
+  - @subpage install
   - @ref contact
 - @subpage tutorial
   - @subpage platform
diff --git a/tools/cmake/DefinePackages.cmake b/tools/cmake/DefinePackages.cmake
index db181aeab0..52317a0ae1 100644
--- a/tools/cmake/DefinePackages.cmake
+++ b/tools/cmake/DefinePackages.cmake
@@ -783,6 +783,7 @@ set(DOC_SOURCES
 
   doc/doxygen/FAQ.doc
   doc/doxygen/advanced.doc
+  doc/doxygen/application.doc
   doc/doxygen/bindings.doc
   doc/doxygen/contributing.doc
   doc/doxygen/deployment.doc