Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How is help text added to function aliases? #45

Open
powercode opened this issue Feb 24, 2022 · 1 comment
Open

How is help text added to function aliases? #45

powercode opened this issue Feb 24, 2022 · 1 comment

Comments

@powercode
Copy link

With

dx -r1 Debugger.State.FunctionAliases

I get

    dflow            [!dflow [<address>]
Shows the instructions of the function containing [<address>] which influence the source operands of that instruction.]
    dis              [!dis [<address>]
Disassembles instructions starting at [<address>] using the data model disassembler.]
    printExceptionStack        <- my function

When registering my own function, it only shows the name of the function.
How can I add help texts?

Regards

Windbg Preview
Debugger client version: 1.2202.7001.0
Debugger engine version: 10.0.22549.1000
@lzybkr
Copy link
Member

lzybkr commented May 27, 2022

The commands descriptions come from the extension gallery manifest.

For example, we have this in the manifest file amd64\OptionalExtensions\DbgModelApiXtn_GalleryManifest.xml:

        <ScriptComponent Name="CodeFlow" Type="Engine" File=".\CodeFlow.js">
            <FunctionAliases>
                <FunctionAlias Name="dflow">
                    <AliasItem>
                        <Syntax>
                            <![CDATA[!dflow [<address>]]]>
                        </Syntax>
                        <Description>
                            <![CDATA[Shows the instructions of the function containing [<address>] which influence the source operands of that instruction.]]>
                        </Description>
                    </AliasItem>
                </FunctionAlias>
                <FunctionAlias Name="dis">
                    <AliasItem>
                        <Syntax>
                            <![CDATA[!dis [<address>]]]>
                        </Syntax>
                        <Description>
                            <![CDATA[Disassembles instructions starting at [<address>] using the data model disassembler.]]>
                        </Description>
                    </AliasItem>
                </FunctionAlias>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants