commit 2cdc9ed361486e176d9dc2e34efc609866d6e9e7
parent 33b0308b198a1d7dcee89edcb551ab2bbad02f6a
Author: Sean Enck <sean@ttypty.com>
Date: Sat, 7 Dec 2024 13:09:10 -0500
cleaning up docs
Diffstat:
3 files changed, 11 insertions(+), 6 deletions(-)
diff --git a/internal/app/core.go b/internal/app/core.go
@@ -115,6 +115,8 @@ type (
ReKeyCommand string
CompletionsCommand string
CompletionsEnv string
+ HelpCommand string
+ HelpConfigCommand string
ReKey struct {
KeyFile string
NoKey string
@@ -252,6 +254,8 @@ func Usage(verbose bool, exe string) ([]string, error) {
RemoveCommand: RemoveCommand,
ReKeyCommand: ReKeyCommand,
CompletionsCommand: CompletionsCommand,
+ HelpCommand: HelpCommand,
+ HelpConfigCommand: HelpConfigCommand,
}
document.ReKey.KeyFile = setDocFlag(reKeyFlags.KeyFile)
document.ReKey.NoKey = reKeyFlags.NoKey
diff --git a/internal/app/core_test.go b/internal/app/core_test.go
@@ -13,7 +13,7 @@ func TestUsage(t *testing.T) {
t.Errorf("invalid usage, out of date? %d", len(u))
}
u, _ = app.Usage(true, "lb")
- if len(u) != 99 {
+ if len(u) != 100 {
t.Errorf("invalid verbose usage, out of date? %d", len(u))
}
for _, usage := range u {
diff --git a/internal/app/doc/toml.txt b/internal/app/doc/toml.txt
@@ -1,10 +1,11 @@
The core components of `{{ $.Executable }}` are controlled via
environment settings, but these settings are secondary (overriden)
-by TOML configuration file(s) if given. The following represents
-all available environment and TOML settings as a TOML file with
-comments indicating the mapping to the underlying environment
-settings.
+by TOML configuration file(s) if given. Run `{{ $.Executable }} {{ $.HelpCommand }} {{ $.HelpConfigCommand
+}}` for more information.
-Arrays defined within the TOML configuration are flattened into
+- TOML values are read, transformed, and set into the process
+environment.
+
+- Arrays defined within the TOML configuration are flattened into
a string (space delimited), quoting should be done within array
parameters when needed.
