From 1de4b017e14542dde8d10eb3aea4f1bdc91639c2 Mon Sep 17 00:00:00 2001 From: Zach Musgrave Date: Tue, 10 Aug 2021 15:45:18 -0700 Subject: [PATCH] More copy editing of sql-server docs --- go/cmd/dolt/commands/sqlserver/sqlserver.go | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/go/cmd/dolt/commands/sqlserver/sqlserver.go b/go/cmd/dolt/commands/sqlserver/sqlserver.go index 02697542f3..55919b8978 100644 --- a/go/cmd/dolt/commands/sqlserver/sqlserver.go +++ b/go/cmd/dolt/commands/sqlserver/sqlserver.go @@ -47,9 +47,14 @@ const ( var sqlServerDocs = cli.CommandDocumentationContent{ ShortDesc: "Start a MySQL-compatible server.", - LongDesc: `By default, starts a MySQL-compatible server which allows only one user connection at a time to the dolt repository in the current directory. Any edits made through this server will be automatically reflected in the working set. This behavior can be modified using a yaml configuration file passed to the server via {{.EmphasisLeft}}--config {{.EmphasisRight}}, or by using the supported switches and flags to configure the server directly on the command line (If {{.EmphasisLeft}}--config {{.EmphasisRight}} is provided all other command line arguments are ignored). This is an example yaml configuration file showing all supported items and their default values: - -` + serverConfigAsYAMLConfig(DefaultServerConfig()).String() + "\n\n" + ` + LongDesc: "By default, starts a MySQL-compatible server on the dolt database in the current directory. " + + "Databases are named after the directories they appear in, with all non-alphanumeric characters replaced by the _ character. " + + "Parameters can be specified using a yaml configuration file passed to the server via " + + "{{.EmphasisLeft}}--config {{.EmphasisRight}}, or by using the supported switches and flags to configure " + + "the server directly on the command line. If {{.EmphasisLeft}}--config {{.EmphasisRight}} is provided all" + + " other command line arguments are ignored.\n\nThis is an example yaml configuration file showing all supported" + + " items and their default values:\n\n" + + serverConfigAsYAMLConfig(DefaultServerConfig()).String() + "\n\n" + ` SUPPORTED CONFIG FILE FIELDS: {{.EmphasisLeft}}vlog_level{{.EmphasisRight}} - Level of logging provided. Options are: {{.EmphasisLeft}}trace{{.EmphasisRight}}, {{.EmphasisLeft}}debug{{.EmphasisRight}}, {{.EmphasisLeft}}info{{.EmphasisRight}}, {{.EmphasisLeft}}warning{{.EmphasisRight}}, {{.EmphasisLeft}}error{{.EmphasisRight}}, and {{.EmphasisLeft}}fatal{{.EmphasisRight}}.