include global parameters and fixup for HTML meta-characters

Author: NikolajBjorner

doc/mk_params_doc.py

@@ -35,7 +35,7 @@ def help(ous):
     ous.write("Z3 Options\n")
     z3_exe = BUILD_DIR + "/z3"
     out = subprocess.Popen([z3_exe, "-pm"],stdout=subprocess.PIPE).communicate()[0]
-    modules = []
+    modules = ["global"]
     if out != None:
         out = out.decode(sys.stdout.encoding)
         module_re = re.compile(r"\[module\] (.*)\,")

src/util/gparams.cpp

@@ -536,15 +536,21 @@ struct gparams::imp {
     void display_module_markdown(std::ostream & out, char const* module_name) {
         lock_guard lock(*gparams_mux);
         param_descrs * d = nullptr;
+
+        if (module_name == std::string("global")) {
+            out << "\n## Global Parameters\n\n";
+            get_param_descrs().display_markdown(out);
+            return;
+        }
         if (!get_module_param_descr(module_name, d)) {
             std::stringstream strm;
             strm << "unknown module '" << module_name << "'";                    
             throw exception(std::move(strm).str());
         }
-        out << "\n## Module " << module_name << "\n\n";
+        out << "\n## " << module_name << "\n\n";
         char const * descr = nullptr;
         if (get_module_descrs().find(module_name, descr)) 
-            out << "Description: " << descr << "\n";
+            out << descr << "\n";
         out << "\n";
         d->display_markdown(out);
     }

src/util/params.cpp

@@ -194,9 +194,19 @@ struct param_descrs::imp {
                 out << " | " << d.m_kind << " ";
             else
                 out << " (" << d.m_kind << ")";
-            if (markdown)
+            if (markdown) {
                 out << " | ";
-            if (include_descr)
+                std::string desc;
+                for (auto ch : std::string(d.m_descr)) {
+                    switch (ch) {
+                    case '<': desc += "&lt;"; break;
+                    case '>': desc += "&gt;"; break;
+                    default: desc.push_back(ch);
+                    }
+                }
+                out << " " << desc;
+            }
+            else if (include_descr)
                 out << " " << d.m_descr;
             if (markdown) {
                 out << " | ";