Tuned messages and options, following Isabelle/c7f3e94fce7b

.woodpecker/build.yml

@@ -10,7 +10,7 @@ pipeline:
       - isabelle build -D . -o browser_info
       - isabelle components -u .
       - isabelle build -D . -o browser_info
-      - isabelle dof_mkroot DOF_test
+      - isabelle dof_mkroot -q DOF_test
       - isabelle build -D DOF_test
       - cp -r $ISABELLE_HOME_USER/browser_info $ARTIFACT_DIR
       - cd $ARTIFACT_DIR

README.md

@@ -99,10 +99,11 @@ Usage: isabelle dof_mkroot [OPTIONS] [DIRECTORY]
     -h           print help
     -n NAME      alternative session name (default: directory base name)
     -o NAMES     list of ontologies, separated by blanks
-                 (default: "Isabelle_DOF.technical_report Isabelle_DOF.scholarly_paper")
-    -t NAME      template (default: "Isabelle_DOF.scrreprt-modern")
+                 (default: "technical_report scholarly_paper")
+    -q           quiet mode: less verbosity
+    -t NAME      template (default: "scrreprt-modern")
 
-  Prepare session root directory for Isabelle/DOF (default: current directory).
+  Create session root directory for Isabelle/DOF (default: current directory).
 ```
 
 ## Releases

examples/technical_report/Isabelle_DOF-Manual/03_GuidedTour.thy

@@ -186,10 +186,11 @@ Usage: isabelle dof_mkroot [OPTIONS] [DIRECTORY]
     -h           print help
     -n NAME      alternative session name (default: directory base name)
     -o NAMES     list of ontologies, separated by blanks
-                 (default: "Isabelle_DOF.technical_report Isabelle_DOF.scholarly_paper")
-    -t NAME      template (default: "Isabelle_DOF.scrreprt-modern")
+                 (default: "technical_report scholarly_paper")
+    -q           quiet mode: less verbosity
+    -t NAME      template (default: "scrreprt-modern")
 
-  Prepare session root directory for Isabelle/DOF (default: current directory).\<close>}
+  Create session root directory for Isabelle/DOF (default: current directory).\<close>}
 \<close>
 
 section*[writing_doc::technical]\<open>Writing Documents: General Remarks\<close>

src/scala/dof_mkroot.scala

@@ -29,7 +29,7 @@
  */
 
 
-/*** prepare session root directory for Isabelle/DOF ***/
+/*** create session root directory for Isabelle/DOF ***/
 
 package isabelle.dof
 
@@ -49,6 +49,7 @@ object DOF_Mkroot
     init_repos: Boolean = false,
     ontologies: List[String] = default_ontologies,
     template: String = default_template,
+    quiet: Boolean = false,
     progress: Progress = new Progress): Unit =
   {
     Isabelle_System.make_directory(session_dir)
@@ -61,12 +62,12 @@ object DOF_Mkroot
     val document_path = session_dir + Path.explode("document")
     if (document_path.file.exists) error("Cannot overwrite existing " + document_path)
 
-    progress.echo("\nPreparing session " + quote(name) + " in " + session_dir)
+    progress.echo("\nCreating session " + quote(name) + " in " + session_dir.absolute)
 
 
     /* ROOT */
 
-    progress.echo("  creating " + root_path)
+    progress.echo_if(!quiet, "  creating " + root_path)
 
     File.write(root_path,
       "session " + Mkroot.root_name(name) + " = " + Mkroot.root_name(DOF.session) + """ +
@@ -81,7 +82,7 @@ object DOF_Mkroot
 """)
 
     val thy = session_dir + Path.explode(name + ".thy")
-    progress.echo("  creating " + thy)
+    progress.echo_if(!quiet, "  creating " + thy)
     File.write(thy,
       "theory\n  " + name +
       "\nimports\n  " + ontologies.map("Isabelle_DOF." + _).mkString("\n  ") +  """
@@ -97,7 +98,7 @@ end
     /* preamble */
 
     val preamble_tex = session_dir + Path.explode("document/preamble.tex")
-    progress.echo("  creating " + preamble_tex)
+    progress.echo_if(!quiet, "  creating " + preamble_tex)
     Isabelle_System.make_directory(preamble_tex.dir)
     File.write(preamble_tex,"""%% This is a placeholder for user-specific configuration and packages.""")
 
@@ -133,7 +134,7 @@ syntax: regexp
 
     {
       val print_dir = session_dir.implode
-      progress.echo("""
+      progress.echo_if(!quiet, """
 Now use the following command line to build the session:
 
   isabelle build -D """ +
@@ -145,7 +146,7 @@ Now use the following command line to build the session:
 
   /** Isabelle tool wrapper **/
 
-  val isabelle_tool = Isabelle_Tool("dof_mkroot", "prepare session root directory for Isabelle/DOF",
+  val isabelle_tool = Isabelle_Tool("dof_mkroot", "create session root directory for Isabelle/DOF",
     Scala_Project.here, args =>
   {
     var init_repos = false
@@ -153,6 +154,7 @@ Now use the following command line to build the session:
     var session_name = ""
     var ontologies = default_ontologies
     var template = default_template
+    var quiet = false
 
     val getopts = Getopts("""
 Usage: isabelle dof_mkroot [OPTIONS] [DIRECTORY]
@@ -163,14 +165,16 @@ Usage: isabelle dof_mkroot [OPTIONS] [DIRECTORY]
     -n NAME      alternative session name (default: directory base name)
     -o NAMES     list of ontologies, separated by blanks
                  (default: """ + quote(Word.implode(default_ontologies)) + """)
+    -q           quiet mode: less verbosity
     -t NAME      template (default: """ + quote(default_template) + """)
 
-  Prepare session root directory for Isabelle/DOF (default: current directory).
+  Create session root directory for Isabelle/DOF (default: current directory).
 """,
       "I" -> (_ => init_repos = true),
       "h" -> (_ => help = true),
       "n:" -> (arg => session_name = arg),
       "o:" -> (arg => ontologies = Word.explode(arg)),
+      "q" -> (_ => quiet = true),
       "t:" -> (arg => template = arg))
 
     val more_args = getopts(args)
@@ -183,8 +187,10 @@ Usage: isabelle dof_mkroot [OPTIONS] [DIRECTORY]
 
     if (help) getopts.usage()
 
+    val progress = new Console_Progress
+
     mkroot(session_name = session_name, session_dir = session_dir,
-      init_repos = init_repos, progress = new Console_Progress,
+      init_repos = init_repos, quiet = quiet, progress = progress,
       ontologies = ontologies, template = template)
   })
 }