go-delve/delve · warning

not documented

Error message

not documented

What it means

When 'help config <validParam>' names a parameter that exists but has no entry in config.Documentation, Delve returns this error. The parameter is valid for 'config' but its documentation string was never written.

Source

Thrown at pkg/terminal/command.go:774

func noCmdAvailable(t *Term, ctx callContext, args string) error {
	return errNoCmd
}

func nullCommand(t *Term, ctx callContext, args string) error {
	return nil
}

func (c *Commands) help(t *Term, ctx callContext, args string) error {
	if args != "" {
		if p1, p2, ok := strings.Cut(args, " "); ok && p1 == "config" {
			if !configureValidParameter(t, p2) {
				return errors.New("unknown config parameter")
			}
			if doc := config.Documentation[p2]; doc != "" {
				fmt.Fprintln(t.stdout, doc)
				return nil
			}
			return errors.New("not documented")
		}

		for _, cmd := range c.cmds {
			if slices.Contains(cmd.aliases, args) {
				fmt.Fprintln(t.stdout, cmd.helpMsg)
				return nil
			}
		}
		return errNoCmd
	}

	fmt.Fprintln(t.stdout, "The following commands are available:")

	for _, cgd := range commandGroupDescriptions {
		fmt.Fprintf(t.stdout, "\n%s:\n", cgd.description)
		w := new(tabwriter.Writer)
		w.Init(t.stdout, 0, 8, 0, '-', 0)
		for _, cmd := range c.cmds {

View on GitHub (pinned to a23773e6c3)

Solutions

1. Use the parameter directly: 'config <param>=<value>' (it is valid even if undocumented)
2. Check Documentation/cli README for the parameter
3. Upgrade Delve; newer versions may add the missing doc string

Example fix

// before
(dlv) help config follow-exec // undocumented in this build
// after
(dlv) config follow-exec=true // set it directly

err := cmds.Help(term, ctx, "config "+param)
if err != nil && strings.Contains(err.Error(), "not documented") {
    // parameter exists; fall back to its default/description via config
fmt.Fprintln(os.Stderr, param, "is valid but undocumented in this Delve build")
}

When it happens

Trigger: Running 'help config <param>' where configureValidParameter passes but config.Documentation[param] is empty.

Common situations: Asking for docs of newer or internal config parameters whose documentation strings are missing in your Delve version.

Related errors

• unknown config parameter
• %q is not a configuration parameter
• command not available
• you must specify a thread
• too many arguments to goroutine

AI-assisted analysis of go-delve/delve@a23773e6c3 (2026-08-31). Data as JSON: /api/errors/28afb26687858a7e. Report an issue: GitHub.