Skip to content

Angle brackets stripped from manpage output #2330

@stgraber

Description

@stgraber

The Incus project got a report that our automatically generated man pages are missing quite a bit of data.

That's because our Use line typically includes placeholders like this: [<remote>:]<instance>

Cobra seems to be generating some basic markdown and then feeding that to md2man.
Unfortunately, it doesn't mark those fields with a backtick or similar escaping so they just get lost in translation.

As a quick test, I've tried feeding cobra's generated markdown doc to md2man and the resulting manpages do contain the expected content.

lxc/incus#2670 was the report on our end.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions