26.7. gdb/mi Command Description Format

The remaining sections describe blocks of commands. Each block of commands is laid out in a fashion similar to this section.

Note the the line breaks shown in the examples are here only for readability. They don't appear in the real output. Also note that the commands with a non-available example (N.A.) are not yet implemented.

26.7.1. Motivation

The motivation for this collection of commands.

26.7.2. Introduction

A brief introduction to this collection of commands as a whole.

26.7.3. Commands

For each command in the block, the following is described:

26.7.3.1. Synopsis

 -command args

26.7.3.2. gdb Command

The corresponding gdb CLI command.

26.7.3.3. Result

The result.

26.7.3.4. Out-of-band

The out-of-band result.

26.7.3.5. Notes

The notes.

26.7.3.6. Example

An example.