docs/devel/writing-monitor-commands.rst

1 How to write monitor commands
4 This document is a step-by-step guide on how to write new QMP commands using
5 the QAPI framework and HMP commands.
14 New commands may be implemented in QMP only.  New HMP commands should be
16 equivalent QMP command, but HMP convenience commands built from QMP
18 existing HMP commands conform to this, to fully isolate HMP from the
20 unstructured text`_ section for further guidance on commands that
93 any data". Now you're ready to enter the QMP example commands as explained in
123 earlier, it's preferable for commands to live in QEMU subsystems. But
141 5. Printing to the terminal is discouraged for QMP commands, we do it here
204 described in the "Testing" section and then send two commands::
225 QMP commands should use the error interface exported by the error.h header
281 With the introduction of QAPI, HMP commands make QMP calls. Most of the
282 time HMP commands are simple wrappers.
314 we should add it to the hmp-commands.hx file::
337 Writing more complex commands
359 Some QMP commands, however, are only intended as ad hoc debugging aids
517 Another important detail is that HMP's "info" commands go into
518 hmp-commands-info.hx, not hmp-commands.hx. The entry for the "info
540 commands expecting machine usage be using fine-grained QAPI data types.
569 commands that are returning unstructured text targeted at
623 monitor users, we should add it to the hmp-commands-info.hx file::