INPUT = doxygen/index.doc \
doxygen/getting_started.doc \
doxygen/getting_started_index.doc \
- doxygen/introduction.doc \
+ doxygen/tutorial.doc \
doxygen/install.doc \
doxygen/examples.doc \
doxygen/platform.doc \
doxygen/advanced.doc \
doxygen/pls.doc \
doxygen/bindings.doc \
- doxygen/internals.doc \
+ doxygen/inside.doc \
doxygen/inside_doxygen.doc \
doxygen/inside_extending.doc \
doxygen/inside_cmake.doc \
\section gs_introduction Introduction, Installation and how we can help
-| Document name | Description |
-| ----------------- | ------------------------------------------------- |
-| \ref introduction | Introduces the user to basic features of SimGrid. |
-| \ref install | Explains how SimGrid can be installed; this covers Windows as well as Linux; plus, it shows how to install from a package or how to install from source. |
-| \ref FAQ | Our FAQ |
-| \ref help | There are many ways to find answers to your questions. This document lists them. |
+| Document name | Description |
+| --------------- | ------------------------------------------------- |
+| \ref tutorial | Introduces the user to basic features of SimGrid. |
+| \ref install | Explains how SimGrid can be installed; this covers Windows as well as Linux; plus, it shows how to install from a package or how to install from source. |
+| \ref FAQ | Our FAQ |
+| \ref help | There are many ways to find answers to your questions. This document lists them. |
\section gs_new_users Documentation for new users
| Document name | Description |
| ----------------- | ------------------------------------------------- |
-| \ref introduction | Introduces the user to basic features of SimGrid. |
+| \ref tutorial | Introduces the user to basic features of SimGrid. |
| \ref install | Explains how SimGrid can be installed; this covers Windows as well as Linux; plus, it shows how to install from a package or how to install from source. |
| [Tutorials](http://simgrid.gforge.inria.fr/tutorials.html) | These tutorials cover most of the basics and might be valuable for what you want to do, especially the [SimGrid User 101](http://simgrid.gforge.inria.fr/tutorials/simgrid-use-101.pdf). |
| \ref MSG_examples | This document explains several tests that we wrote for MSG; these tests are working simulations and you may learn something from looking at them. |
| \ref tracing | Shows how the behavior of a program can be written to a file so that it can be analyzed. |
| \ref bindings | SimGrid supports many different bindings for languages such as Lua, Ruby, Java, ... You can run your simulations with those! |
| \ref pls | Although SimGrid is not a packet level simulator, it does have bindings to two such simulators. |
-| \ref internals | If you want to contribute or obtain a deeper understanding of SimGrid, this is the right location. |
+| \ref inside | If you want to contribute or obtain a deeper understanding of SimGrid, this is the right location. |
\section gs_examples Examples shipped with SimGrid
<tr><td width="50%">
@endhtmlonly
-- @subpage introduction
+- @subpage tutorial
- @subpage platform
- @subpage options
- @subpage deployment
- @ref bindings
- @ref pls
- @ref tracing
- - @ref contributing
- @subpage FAQ
-- @subpage internals
+- @subpage inside
+ - @ref inside_tests
+ - @ref inside_doxygen
+ - @ref inside_extending
+ - @ref inside_cmake
+ - @ref inside_release
- @subpage contributing
@htmlonly
-/*! @page internals SimGrid Developer Guide
+/*! @page inside SimGrid Developer Guide
This page does not exist yet, sorry. We are currently refurbishing the
user documentation -- the internal documentation will follow (FIXME).
test your code this way, but make sure that it runs reasonably fast,
or nobody will run "ctest" before commiting code.
-For more details on how the tests are extracted from the module
-source, check the tools/sg_unit_extractor.pl script directly.
+For more details on the macro used to write unit tests, see their
+reference guide: @ref XBT_cunit. For details on on how the tests are
+extracted from the module source, check the tools/sg_unit_extractor.pl
+script directly.
\section inside_tests_add_integration Adding integration tests
Once everything is built, you may want to test the result. SimGrid
comes with an extensive set of regression tests (see @ref
-inside_cmake_addtest "that page of the insider manual" for more
+inside_tests "that page of the insider manual" for more
details). Running the tests is done using the ctest binary that comes
with cmake. These tests are run for every commit and the result is
publicly <a href="https://ci.inria.fr/simgrid/">available</a>.
-/*! @page introduction Introduction to SimGrid
+/*! @page tutorial SimGrid First Tutorial
[SimGrid](http://simgrid.gforge.inria.fr/) is a toolkit
* Note that if you want to test a full binary (such as an example),
* you want to use our integration testing mechanism, not our unit
* testing one. Please refer to Section \ref
- * inside_cmake_addtest_integration
+ * inside_tests_add_integration
*
- * Some more information on our unit testing is available in Section @ref inside_cmake_addtest_unit.
+ * Some more information on our unit testing is available in Section @ref inside_tests_add_units.
*
* All code intended to be executed as a unit test will be extracted
* by a script (tools/sg_unit_extract.pl), and must thus be protected
doc/doxygen/header.html
doc/doxygen/help.doc
doc/doxygen/index.doc
+ doc/doxygen/inside.doc
doc/doxygen/inside_tests.doc
doc/doxygen/inside_cmake.doc
doc/doxygen/inside_doxygen.doc
doc/doxygen/inside_extending.doc
doc/doxygen/inside_release.doc
doc/doxygen/install.doc
- doc/doxygen/internals.doc
- doc/doxygen/introduction.doc
+ doc/doxygen/tutorial.doc
doc/doxygen/module-msg.doc
doc/doxygen/module-sd.doc
doc/doxygen/module-simix.doc
