Document changes for upcoming v0.2.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 7c5a649561c17d672ba42124ea72c7a3a6797081..25d7642599604dba642e9ec0386f5c8721e5dbad 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -80,6 +80,7 @@ namespace opt {
     unsigned lb_maxiter = 0;
     unsigned comp_maxiter = 0;
     double time_limit = 0;
+    int exit_on_convergence = 0;
     bool exit_on_close = true;
 
     // Named parameters lists
@@ -233,7 +234,7 @@ bool opt::parse_args(int* argc, char* argv[])
     opterr = 0;
     while ((c = getopt(*argc, argv,
                        "%:"
-                       "a:bc:C:d:D:eEhi:I:k:l:L:m:M:N:r:Rs:S:t:T:vVx:X:Z"))
+                       "a:bc:C:d:D:eEg:hi:I:k:l:L:m:M:N:r:Rs:S:t:T:vVx:X:Z"))
            != -1) {
         switch (c) {
         case '%':
@@ -279,6 +280,9 @@ bool opt::parse_args(int* argc, char* argv[])
         case 'E':
             opt::egocentric = !opt::egocentric;
             break;
+        case 'g':
+            PARSE_ARG(opt::exit_on_convergence);
+            break;
         case 'h':
             opt::help_requested++;
             break;
@@ -443,6 +447,8 @@ void opt::print()
           h.val_or_string(comp_maxiter, "no limit"));
     DESCR("convergence is assumed within (\%)", "%g", opt::avg_load_ratio);
     DESCR("time limit", "%s", h.val_or_string(time_limit, "no limit"));
+    DESCR("exit on convergence", "%s",
+          h.val_or_string(exit_on_convergence, "disabled"));
     DESCR("exit on close", "%s", h.on_off(exit_on_close));
     XBT_INFO("`----");
 
@@ -564,6 +570,15 @@ void opt::usage()
     std::clog << o("-% value")
               << "percent of the load average to assume the convergence"
               << " [" << opt::avg_load_ratio << "]\n";
+    if (opt::help_requested > 1)
+        std::clog << o("")
+                  << "- if negative: use 100 * (nhosts / -value) / avg_load\n";
+    std::clog << o("-g value")
+              << "number of consecutive detections of convergence to exit"
+              << " [" << opt::exit_on_convergence << "]\n";
+    if (opt::help_requested > 1)
+        std::clog << o("")
+                  << "- use 0 to disable\n";
     std::clog << o("-t value")
               << "time limit (simulated time), 0 for no limit"
               << " [" << opt::time_limit << "]\n";