From: Martin Quinson Date: Wed, 25 May 2016 19:42:24 +0000 (+0200) Subject: short note on describing the platf with lua X-Git-Tag: v3_14~1165 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/844c9baa41ffb9963bbbe8146b36b9323cc4ca6f short note on describing the platf with lua --- diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index a6c08e03b0..da938496cc 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -650,6 +650,7 @@ INPUT = doxygen/index.doc \ doxygen/platform.doc \ doxygen/models.doc \ doxygen/ns3.doc \ + doxygen/platform_lua.doc \ doxygen/scenario.doc \ doxygen/deployment.doc \ doxygen/options.doc \ diff --git a/doc/doxygen/bindings.doc b/doc/doxygen/bindings.doc index d89e426c76..7eabede0e5 100644 --- a/doc/doxygen/bindings.doc +++ b/doc/doxygen/bindings.doc @@ -232,16 +232,4 @@ If you want to make this change permanent on your machine, edit your `/etc/sysctl.conf` file. Otherwise, you have to redo it by calling sysctl after each reboot. -\section bindings_binding_lua Lua Binding - -\subsection bindings_binding_lua_about What is lua ? -Lua is a lightweight, reflective, imperative and functional programming language, - designed as a scripting language with extensible semantics as a primary goal (see official web site here). -\subsubsection bindings_binding_lua_why Why lua ? -Lua is a fast, portable and powerful script language, quite simple to use for developpers. -it combines procedural features with powerful data description facilities, - by using a simple, yet powerful, mechanism of tables. -Lua has a relatively simple C API compared to other scripting languages, -and accordingly it provides a robust, easy to use it. - */ diff --git a/doc/doxygen/index.doc b/doc/doxygen/index.doc index cc54313e2a..483cd4aaa0 100644 --- a/doc/doxygen/index.doc +++ b/doc/doxygen/index.doc @@ -19,6 +19,7 @@ - @subpage bindings - @subpage platform - @subpage models + - @subpage platform_lua - @subpage pls_ns3 - @subpage scenario - @subpage deployment diff --git a/doc/doxygen/platform_lua.doc b/doc/doxygen/platform_lua.doc new file mode 100644 index 0000000000..81ea6497ab --- /dev/null +++ b/doc/doxygen/platform_lua.doc @@ -0,0 +1,30 @@ +/*! \page platform_lua Describing the platform with lua + +@tableofcontents + +To describe your virtual platform, you can provide a lua script +instead of an XML file. In the near future, this should become +possible from in C++ and Java thanks to the the S4U interface. When +this happens, the lua interface will be changed to match the S4U one. + +That is why the current lua API is not documented. It is very close to +the XML interface, and you have some examples that you can use to +understand this module. If you use the current API, just drop us a +mail so that we keep it working once S4U is out, to give you the time +to switch at your pace. + + +\section pf_lua_why Why lua ? + +Lua is a fast and portable scripting language. Its main goal is to +make the internal mechanics of C/C++ programs easily recombinable from +a script. It is for example heavily used in the gaming industry: C++ +programmers do fast 3D game engines, that game designers reuse easily to +tell stories. + +Similarly, our goal is to decouple the internals of the simulation +engine from the usage of that engine. It should give our users the +full power of reconfiguring the tool without digging into our +implementation. Admittedly, we are not there yet... + +*/ diff --git a/tools/cmake/DefinePackages.cmake b/tools/cmake/DefinePackages.cmake index 687546a6d4..c14bf259e9 100644 --- a/tools/cmake/DefinePackages.cmake +++ b/tools/cmake/DefinePackages.cmake @@ -822,6 +822,7 @@ set(DOC_SOURCES doc/doxygen/outcomes_MC.doc doc/doxygen/outcomes_vizu.doc doc/doxygen/platform.doc + doc/doxygen/platform_lua.doc doc/doxygen/scenario.doc doc/doxygen/stylesheet.css doc/doxygen/uhood.doc