From ffc874c5572820b9e2533d6e7b01602bfd5909d2 Mon Sep 17 00:00:00 2001
From: Arnaud Giersch <arnaud.giersch@iut-bm.univ-fcomte.fr>
Date: Thu, 16 Dec 2010 12:13:12 +0100
Subject: [PATCH 1/1] Improve documentation.

---
 README      | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 main.cpp    |  2 +-
 options.cpp | 16 +++++++++-
 3 files changed, 105 insertions(+), 2 deletions(-)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..db47b28
--- /dev/null
+++ b/README
@@ -0,0 +1,89 @@
+Compilation de SimGrid
+======================
+
+Dans les sources :
+        $ cmake -D CMAKE_INSTALL_PREFIX=/usr/local      # par exemple
+        $ make
+        $ make install
+
+Compilation...
+==============
+
+Il faut avoir un lien "simgrid-stable" vers le répertoire
+d'installation de SimGrid (par ex. /usr/local).
+
+Utilisation
+===========
+
+Pour avoir l'aide en ligne :
+$ ./loba -hhh
+
+Pour changer le niveau de détail des affichages :
+        --log=category.thres:level
+    avec
+        category : simu, main, depl, comm, proc, loba
+    et
+        level : trace, debug, verbose, info, warning, error, critical
+
+Fichiers
+========
+
+* fichiers de description de plates-formes
+
+    Plat.xml
+    cluster1000.xml
+    platform.xml
+
+* fichiers de description de déploiement (tests)
+
+    Dep.xml                     à utiliser avec Plat.xml
+    deployment.xml              à utiliser avec platform.xml
+
+* fichiers sources
+
+    communicator.h
+    communicator.cpp            la couche de communication
+
+    cost_func.h
+    cost_func.cpp               fonctions de coût pour comm_cost et comp_cost
+
+    deployment.h
+    deployment.cpp              génération automatique de déploiement
+
+    hostdata.h                  gestion des boites de réception, par hôte
+    hostdata.cpp
+
+    loba_simple.h               load-balancing simple (à copier pour ajouter
+    loba_simple.cpp             d'autres algorithmes)
+
+    main.cpp                    le programme principal
+
+    misc.h                      divers trucs inclassables
+    misc.cpp
+
+    named_object_list.h         gestion d'une table de constructeurs
+                                avec des noms et des descritpions
+
+    neighbor.h                  un voisin pour un processus
+    neighbor.cpp
+
+    options.h                   gestion des paramètres et options globaux
+    options.cpp
+
+    process.h                   classe de base pour un processus
+    process.cpp
+
+    simgrid_features.h          macros pour détecter la version de SimGrid
+
+    simple_async.cpp            un simple programme de test
+
+    timer.h                     gestion de timer
+
+    version.h                   gestion de la version du programme
+    version.cpp
+
+* autres fichiers
+
+    .gitignore                  liste des fichiers ignorés par git
+    valgrind_suppressions_3.5   liste de quelques suppressions pour valgrind
+                                avec SimGrid 3.5
diff --git a/main.cpp b/main.cpp
index 7bbe686..0ec5b6d 100644
--- a/main.cpp
+++ b/main.cpp
@@ -12,7 +12,7 @@
 #include "version.h"
 
 // Creates log categories
-XBT_LOG_NEW_CATEGORY(simu, "Simulation messages");
+XBT_LOG_NEW_CATEGORY(simu, "Root of simulation messages");
 XBT_LOG_NEW_SUBCATEGORY(main, simu, "Messages from global infrastructure");
 XBT_LOG_NEW_SUBCATEGORY(depl, main, "Messages from auto deployment");
 XBT_LOG_NEW_SUBCATEGORY(comm, simu, "Messages from asynchronous pipes");
diff --git a/options.cpp b/options.cpp
index 54fd53d..1b12ce7 100644
--- a/options.cpp
+++ b/options.cpp
@@ -204,7 +204,7 @@ void opt::usage()
 
     std::clog << "\nGlobal options\n";
     std::clog << o("-h")
-              << "print help and exit (use -hh for extended help)\n";
+              << "print help and exit (use -hh or -hhh for extended help)\n";
     if (opt::help_requested < 1)
         return;
 
@@ -248,6 +248,20 @@ void opt::usage()
               << "maximum number of iterations, 0 for infinity"
               << " (" << opt::maxiter << ")\n";
 
+    if (opt::help_requested < 3)
+        return;
+
+    std::clog << "\nLogging support\n"
+              << "    See SimGrid documentation on:\n"
+              << "        http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_user\n"
+              << "    Existing categories are:\n"
+              << "        simu : root of following categories\n"
+              << "        main : messages from global infrastructure\n"
+              << "        depl : messages from auto deployment (inherited from main)\n"
+              << "        comm : messages from asynchronous pipes\n"
+              << "        proc : messages from base process class\n"
+              << "        loba : messages from load-balancer\n";
+
 #undef so_list
 #undef so
 #undef o
-- 
2.39.5