From: Arnaud Giersch <arnaud.giersch@iut-bm.univ-fcomte.fr>
Date: Mon, 18 Apr 2011 16:21:37 +0000 (+0200)
Subject: Improve help messages.
X-Git-Tag: v0.1~69^2~1
X-Git-Url: https://bilbo.iut-bm.univ-fcomte.fr/and/gitweb/loba.git/commitdiff_plain/0067a8f018a2bf7a6e02f60823594594abe4c509?ds=sidebyside;hp=--cc

Improve help messages.
---

0067a8f018a2bf7a6e02f60823594594abe4c509
diff --git a/options.cpp b/options.cpp
index f8d6eea..23783fa 100644
--- a/options.cpp
+++ b/options.cpp
@@ -417,8 +417,9 @@ void opt::usage()
 
     std::clog << "Usage: " << opt::program_name
               << " [options] <platform_file> [<deployment_file>]\n";
+    std::clog << "Current values for the parameters are given between square brackets.\n";
 
-    std::clog << "\nGlobal options\n";
+    std::clog << "\nGlobal options:\n";
     std::clog << o("-h")
               << "print help and exit (use -hh or -hhh for extended help)\n";
     if (opt::help_requested < 1)
@@ -427,14 +428,14 @@ void opt::usage()
     std::clog << o("--help") << "print help from SimGrid framework and exit\n";
     std::clog << o("-V") << "print version and exit\n";
 
-    std::clog << "\nSimulation parameters\n";
+    std::clog << "\nSimulator output:\n";
     std::clog << o("-l value")
               << "print current load every n lb iterations, 0 to disable"
               << " [" << opt::log_rate << "]\n";
     std::clog << o("-v")
               << "verbose: do not override the default logging parameters\n";
 
-    std::clog << "\nAutomatic deployment options\n";
+    std::clog << "\nAutomatic deployment:\n";
     std::clog << o("-T name")
               << "enable automatic deployment with selected topology"
               << " [" << opt::auto_depl::topology << "]\n";
@@ -451,21 +452,32 @@ void opt::usage()
               << " [" << opt_helper::on_off(opt::auto_depl::random_distribution)
               << "]\n";
     std::clog << o("-r value")
-              << "random seed, 0 for using it on time()"
+              << "random seed, 0 for a seed based on current date"
               << " [" << opt::auto_depl::random_seed << "]\n";
 
-    std::clog << "\nLoad balancing algorithm\n";
+    std::clog << "\nLoad balancing algorithm:\n";
     std::clog << o("-a name") << "load balancing algorithm"
               << " [" << opt::loba_algo << "]\n";
     if (opt::help_requested > 1)
         so_list(opt::loba_algorithms);
     std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
               << " [" << opt_helper::on_off(opt::bookkeeping) << "]\n";
+
+    std::clog << "\nLb. and comp. iterations:\n";
     std::clog << o("-s value")
               << "minimum duration between lb. iterations"
               << " [" << opt::min_lb_iter_duration << "]\n";
+    std::clog << o("-S value")
+              << "minimum duration between comp. iterations"
+              << " [" << opt::min_comp_iter_duration << "]\n";
+    std::clog << o("-d value")
+              << "start comp. iterations after given number of lb. iterations"
+              << " [" << opt::comp_iter_delay << "]\n";
+    std::clog << o("-D value")
+              << "start comp. iterations after given time"
+              << " [" << opt::comp_time_delay << "]\n";
 
-    std::clog << "\nApplication parameters\n";
+    std::clog << "\nComputations and communications:\n";
     std::clog << o("-c [aN,...]a0")
               << "polynomial factors for computation cost"
               << " [" << opt::comp_cost.to_string() << "]\n";
@@ -478,17 +490,8 @@ void opt::usage()
     std::clog << o("-M value")
               << "maximum data transfer amount, 0 for no limit"
               << " [" << opt::max_transfer_amount << "]\n";
-    std::clog << o("-S value")
-              << "minimum duration between comp. iterations"
-              << " [" << opt::min_comp_iter_duration << "]\n";
-    std::clog << o("-d value")
-              << "start computations after given number of lb iterations"
-              << " [" << opt::comp_iter_delay << "]\n";
-    std::clog << o("-D value")
-              << "start computations after given time"
-              << " [" << opt::comp_time_delay << "]\n";
 
-    std::clog << "\nParameters for the end of the simulation\n";
+    std::clog << "\nEnd of the simulation:\n";
     std::clog << o("-i value")
               << "maximum number of lb. iterations, 0 for no limit"
               << " [" << opt::lb_maxiter << "]\n";
@@ -504,7 +507,7 @@ void opt::usage()
     if (opt::help_requested < 3)
         return;
 
-    std::clog << "\nLogging support\n"
+    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"