Changeset 69602

Timestamp:

Sep 28, 2016, 6:18:39 PM (8 years ago)

Author:

wenzeslaus

Message:

parser: make --help shorter

By removing standard/long/common flags, making description just the label,
leaving out keywords, printing only label for flags and options
and not printing descriptions for options of an option,
the output is shorter going from 48 to 32 for r.slope.aspect
and from 72 to 43 lines for v.in.lidar.

This was done according to GRASS-dev mailing list
Adding an expert mode to the parser
​https://lists.osgeo.org/pipermail/grass-dev/2016-September/082519.html

File:

• grass/trunk/lib/gis/parser_help.c (modified) (6 diffs)

grass/trunk/lib/gis/parser_help.c

@@ -65 +65 @@
     int len, n;
     int new_prompt = 0;
+    int extensive = 0;  /* include also less important parts */
+    int standard = 0;  /* include also standard flags */
+    int detailed = 0;  /* details for each flag and option */
 
     new_prompt = G__uses_new_gisprompt();
@@ -74 +77 @@
 
     if (st->module_info.label || st->module_info.description) {
-        fprintf(fp, "\n");
+        if (extensive)
+            fprintf(fp, "\n");
         if (markers)
             fprintf(fp, "{{{DESCRIPTION}}}\n");
-        fprintf(fp, "%s\n", _("Description:"));
-        if (st->module_info.label)
-            fprintf(fp, " %s\n", st->module_info.label);
-        if (st->module_info.description)
-            fprintf(fp, " %s\n", st->module_info.description);
-    }
-    if (st->module_info.keywords) {
+        if (extensive) {
+            fprintf(fp, "%s\n", _("Description:"));
+            if (st->module_info.label)
+                fprintf(fp, " %s\n", st->module_info.label);
+            if (st->module_info.description)
+                fprintf(fp, " %s\n", st->module_info.description);
+        }
+        else {
+            /* print label, if no label, try description */
+            /* no leading space without heading */
+            if (st->module_info.label)
+                fprintf(fp, "%s\n", st->module_info.label);
+            else if (st->module_info.description)
+                fprintf(fp, "%s\n", st->module_info.description);
+        }
+    }
+    if (extensive &&& st->module_info.keywords) {
         fprintf(fp, "\n");
         if (markers)
@@ -184 +198 @@
             if (flag->label) {
                 fprintf(fp, "%s\n", flag->label);
-                if (flag->description)
+                if (detailed && flag->description)
                     fprintf(fp, "        %s\n", flag->description);
 
@@ -196 +210 @@
     }
 
-    if (new_prompt)
-        fprintf(fp, " --o   %s\n",
-                _("Allow output files to overwrite existing files"));
-
-    fprintf(fp, " --h   %s\n", _("Print usage summary"));
-    fprintf(fp, " --v   %s\n", _("Verbose module output"));
-    fprintf(fp, " --q   %s\n", _("Quiet module output"));
-    fprintf(fp, " --qq  %s\n", _("Super quiet module output"));
-    fprintf(fp, " --ui  %s\n", _("Force launching GUI dialog"));
-    
+    if (standard) {
+        if (new_prompt)
+            fprintf(fp, " --o   %s\n",
+                    _("Allow output files to overwrite existing files"));
+
+        fprintf(fp, " --h   %s\n", _("Print usage summary"));
+        fprintf(fp, " --v   %s\n", _("Verbose module output"));
+        fprintf(fp, " --q   %s\n", _("Quiet module output"));
+        fprintf(fp, " --qq  %s\n", _("Super quiet module output"));
+        fprintf(fp, " --ui  %s\n", _("Force launching GUI dialog"));
+    }
+
     /* Print help info for options */
 
@@ -219 +235 @@
             if (opt->label) {
                 fprintf(fp, "%s\n", opt->label);
-                if (opt->description) {
+                if (detailed && opt->description) {
                     fprintf(fp, "  %*s    %s\n",
                             maxlen, " ", opt->description);
@@ -238 +254 @@
                         opt->def);
 
-            if (opt->descs) {
+            if (detailed && opt->descs) {
                 int i = 0;