hmp: Fix texinfo documentation
Several issues:
* Commands i and o lack @item. Their one-liner documentation gets
squashed into the preceding command print. Add the obvious @item.
* Commands i, o and cpu-add lack @findex. The function index doesn't
have them. Add the obvious @findex.
* Commit 727f005
put block_set_io_throttle was added in the middle of
block_passwd. Move it.
* Correct spelling of commands chardev-add and chardev-remove in @item
and @findex.
* Some commands have a blank line between @item/@findex and the text,
most don't. Normalize to no blank line.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>
This commit is contained in:
parent
de7ad4ce1f
commit
b76d799ea5
@ -204,7 +204,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item change @var{device} @var{setting}
|
@item change @var{device} @var{setting}
|
||||||
@findex change
|
@findex change
|
||||||
|
|
||||||
Change the configuration of a device.
|
Change the configuration of a device.
|
||||||
|
|
||||||
@table @option
|
@table @option
|
||||||
@ -522,7 +521,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item p or print/@var{fmt} @var{expr}
|
@item p or print/@var{fmt} @var{expr}
|
||||||
@findex print
|
@findex print
|
||||||
|
|
||||||
Print expression value. Only the @var{format} part of @var{fmt} is
|
Print expression value. Only the @var{format} part of @var{fmt} is
|
||||||
used.
|
used.
|
||||||
ETEXI
|
ETEXI
|
||||||
@ -536,6 +534,8 @@ ETEXI
|
|||||||
},
|
},
|
||||||
|
|
||||||
STEXI
|
STEXI
|
||||||
|
@item i/@var{fmt} @var{addr} [.@var{index}]
|
||||||
|
@findex i
|
||||||
Read I/O port.
|
Read I/O port.
|
||||||
ETEXI
|
ETEXI
|
||||||
|
|
||||||
@ -548,6 +548,8 @@ ETEXI
|
|||||||
},
|
},
|
||||||
|
|
||||||
STEXI
|
STEXI
|
||||||
|
@item o/@var{fmt} @var{addr} @var{val}
|
||||||
|
@findex o
|
||||||
Write to I/O port.
|
Write to I/O port.
|
||||||
ETEXI
|
ETEXI
|
||||||
|
|
||||||
@ -563,7 +565,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item sendkey @var{keys}
|
@item sendkey @var{keys}
|
||||||
@findex sendkey
|
@findex sendkey
|
||||||
|
|
||||||
Send @var{keys} to the guest. @var{keys} could be the name of the
|
Send @var{keys} to the guest. @var{keys} could be the name of the
|
||||||
key or the raw value in hexadecimal format. Use @code{-} to press
|
key or the raw value in hexadecimal format. Use @code{-} to press
|
||||||
several keys simultaneously. Example:
|
several keys simultaneously. Example:
|
||||||
@ -586,7 +587,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item system_reset
|
@item system_reset
|
||||||
@findex system_reset
|
@findex system_reset
|
||||||
|
|
||||||
Reset the system.
|
Reset the system.
|
||||||
ETEXI
|
ETEXI
|
||||||
|
|
||||||
@ -601,7 +601,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item system_powerdown
|
@item system_powerdown
|
||||||
@findex system_powerdown
|
@findex system_powerdown
|
||||||
|
|
||||||
Power down the system (if supported).
|
Power down the system (if supported).
|
||||||
ETEXI
|
ETEXI
|
||||||
|
|
||||||
@ -616,7 +615,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item sum @var{addr} @var{size}
|
@item sum @var{addr} @var{size}
|
||||||
@findex sum
|
@findex sum
|
||||||
|
|
||||||
Compute the checksum of a memory region.
|
Compute the checksum of a memory region.
|
||||||
ETEXI
|
ETEXI
|
||||||
|
|
||||||
@ -631,7 +629,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item usb_add @var{devname}
|
@item usb_add @var{devname}
|
||||||
@findex usb_add
|
@findex usb_add
|
||||||
|
|
||||||
Add the USB device @var{devname}. For details of available devices see
|
Add the USB device @var{devname}. For details of available devices see
|
||||||
@ref{usb_devices}
|
@ref{usb_devices}
|
||||||
ETEXI
|
ETEXI
|
||||||
@ -647,7 +644,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item usb_del @var{devname}
|
@item usb_del @var{devname}
|
||||||
@findex usb_del
|
@findex usb_del
|
||||||
|
|
||||||
Remove the USB device @var{devname} from the QEMU virtual USB
|
Remove the USB device @var{devname} from the QEMU virtual USB
|
||||||
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
|
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
|
||||||
command @code{info usb} to see the devices you can remove.
|
command @code{info usb} to see the devices you can remove.
|
||||||
@ -666,7 +662,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item device_add @var{config}
|
@item device_add @var{config}
|
||||||
@findex device_add
|
@findex device_add
|
||||||
|
|
||||||
Add device.
|
Add device.
|
||||||
ETEXI
|
ETEXI
|
||||||
|
|
||||||
@ -682,7 +677,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item device_del @var{id}
|
@item device_del @var{id}
|
||||||
@findex device_del
|
@findex device_del
|
||||||
|
|
||||||
Remove device @var{id}.
|
Remove device @var{id}.
|
||||||
ETEXI
|
ETEXI
|
||||||
|
|
||||||
@ -823,7 +817,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item boot_set @var{bootdevicelist}
|
@item boot_set @var{bootdevicelist}
|
||||||
@findex boot_set
|
@findex boot_set
|
||||||
|
|
||||||
Define new values for the boot device list. Those values will override
|
Define new values for the boot device list. Those values will override
|
||||||
the values specified on the command line through the @code{-boot} option.
|
the values specified on the command line through the @code{-boot} option.
|
||||||
|
|
||||||
@ -1538,9 +1531,9 @@ ETEXI
|
|||||||
},
|
},
|
||||||
|
|
||||||
STEXI
|
STEXI
|
||||||
@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
|
@item block_passwd @var{device} @var{password}
|
||||||
@findex block_set_io_throttle
|
@findex block_passwd
|
||||||
Change I/O throttle limits for a block drive to @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
|
Set the encrypted device @var{device} password to @var{password}
|
||||||
ETEXI
|
ETEXI
|
||||||
|
|
||||||
{
|
{
|
||||||
@ -1552,9 +1545,9 @@ ETEXI
|
|||||||
},
|
},
|
||||||
|
|
||||||
STEXI
|
STEXI
|
||||||
@item block_passwd @var{device} @var{password}
|
@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
|
||||||
@findex block_passwd
|
@findex block_set_io_throttle
|
||||||
Set the encrypted device @var{device} password to @var{password}
|
Change I/O throttle limits for a block drive to @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
|
||||||
ETEXI
|
ETEXI
|
||||||
|
|
||||||
{
|
{
|
||||||
@ -1568,7 +1561,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item set_password [ vnc | spice ] password [ action-if-connected ]
|
@item set_password [ vnc | spice ] password [ action-if-connected ]
|
||||||
@findex set_password
|
@findex set_password
|
||||||
|
|
||||||
Change spice/vnc password. Use zero to make the password stay valid
|
Change spice/vnc password. Use zero to make the password stay valid
|
||||||
forever. @var{action-if-connected} specifies what should happen in
|
forever. @var{action-if-connected} specifies what should happen in
|
||||||
case a connection is established: @var{fail} makes the password change
|
case a connection is established: @var{fail} makes the password change
|
||||||
@ -1588,7 +1580,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item expire_password [ vnc | spice ] expire-time
|
@item expire_password [ vnc | spice ] expire-time
|
||||||
@findex expire_password
|
@findex expire_password
|
||||||
|
|
||||||
Specify when a password for spice/vnc becomes
|
Specify when a password for spice/vnc becomes
|
||||||
invalid. @var{expire-time} accepts:
|
invalid. @var{expire-time} accepts:
|
||||||
|
|
||||||
@ -1619,9 +1610,8 @@ ETEXI
|
|||||||
},
|
},
|
||||||
|
|
||||||
STEXI
|
STEXI
|
||||||
@item chardev_add args
|
@item chardev-add args
|
||||||
@findex chardev_add
|
@findex chardev-add
|
||||||
|
|
||||||
chardev_add accepts the same parameters as the -chardev command line switch.
|
chardev_add accepts the same parameters as the -chardev command line switch.
|
||||||
|
|
||||||
ETEXI
|
ETEXI
|
||||||
@ -1636,9 +1626,8 @@ ETEXI
|
|||||||
},
|
},
|
||||||
|
|
||||||
STEXI
|
STEXI
|
||||||
@item chardev_remove id
|
@item chardev-remove id
|
||||||
@findex chardev_remove
|
@findex chardev-remove
|
||||||
|
|
||||||
Removes the chardev @var{id}.
|
Removes the chardev @var{id}.
|
||||||
|
|
||||||
ETEXI
|
ETEXI
|
||||||
@ -1654,7 +1643,6 @@ ETEXI
|
|||||||
STEXI
|
STEXI
|
||||||
@item qemu-io @var{device} @var{command}
|
@item qemu-io @var{device} @var{command}
|
||||||
@findex qemu-io
|
@findex qemu-io
|
||||||
|
|
||||||
Executes a qemu-io command on the given block device.
|
Executes a qemu-io command on the given block device.
|
||||||
|
|
||||||
ETEXI
|
ETEXI
|
||||||
@ -1669,6 +1657,7 @@ ETEXI
|
|||||||
|
|
||||||
STEXI
|
STEXI
|
||||||
@item cpu-add @var{id}
|
@item cpu-add @var{id}
|
||||||
|
@findex cpu-add
|
||||||
Add CPU with id @var{id}
|
Add CPU with id @var{id}
|
||||||
ETEXI
|
ETEXI
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user