Better on-line help for auxents and terminals

johnkerl · May 15, 2023 · b822ff0 · b822ff0
1 parent 145a25e
commit b822ff0
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/internal/pkg/auxents/auxents.go b/internal/pkg/auxents/auxents.go
@@ -60,9 +60,9 @@ func auxListMain(args []string) int {
 
 // ShowAuxEntries is a symbol is exported for 'mlr --help'.
 func ShowAuxEntries(o *os.File) {
-	fmt.Fprintf(o, "Available subcommands:\n")
+	fmt.Fprintf(o, "Available entries:\n")
 	for _, entry := range _AUX_LOOKUP_TABLE {
-		fmt.Fprintf(o, "  %s\n", entry.name)
+		fmt.Fprintf(o, "  mlr %s\n", entry.name)
 	}
 
 	fmt.Fprintf(o, "For more information, please invoke mlr {subcommand} --help.\n")

diff --git a/internal/pkg/terminals/help/entry.go b/internal/pkg/terminals/help/entry.go
@@ -10,6 +10,7 @@ import (
 
 	"github.com/mattn/go-isatty"
 
+	"github.com/johnkerl/miller/internal/pkg/auxents"
 	"github.com/johnkerl/miller/internal/pkg/bifs"
 	"github.com/johnkerl/miller/internal/pkg/cli"
 	"github.com/johnkerl/miller/internal/pkg/dsl/cst"
@@ -325,12 +326,14 @@ func listSeparatorRegexAliases() {
 func helpAuxents() {
 	fmt.Print(`Miller has a few otherwise-standalone executables packaged within it.
 They do not participate in any other parts of Miller.
-Please "mlr aux-list" for more information.
 `)
+	fmt.Println()
+	auxents.ShowAuxEntries(os.Stdout)
 }
 
 func helpTerminals() {
-	fmt.Println("Terminals include on-line help, regression-test entry point, and the REPL.")
+	fmt.Println("Terminals include mlr help, the regression-test entry point mlr regtest, and the REPL mlr repl.")
+	// We can't invoke the terminal-lister since that would create a cyclic package reference.
 }
 
 // ----------------------------------------------------------------

diff --git a/internal/pkg/terminals/repl/entry.go b/internal/pkg/terminals/repl/entry.go
@@ -185,14 +185,14 @@ func ReplMain(args []string) int {
 
 	err = repl.handleSession(os.Stdin)
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "mlr s: %v", repl.replName, err)
+		fmt.Fprintf(os.Stderr, "mlr %s: %v", repl.replName, err)
 		os.Exit(1)
 	}
 
 	repl.bufferedRecordOutputStream.Flush()
 	err = repl.closeBufferedOutputStream()
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "mlr s: %v", repl.replName, err)
+		fmt.Fprintf(os.Stderr, "mlr %s: %v", repl.replName, err)
 		os.Exit(1)
 	}
 	return 0