[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-trivial] [PULL 21/24] hmp: Fix texinfo documentation
From: |
Michael Tokarev |
Subject: |
[Qemu-trivial] [PULL 21/24] hmp: Fix texinfo documentation |
Date: |
Thu, 19 Mar 2015 12:05:39 +0300 |
From: Markus Armbruster <address@hidden>
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 <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
Signed-off-by: Michael Tokarev <address@hidden>
---
hmp-commands.hx | 41 +++++++++++++++--------------------------
1 file changed, 15 insertions(+), 26 deletions(-)
diff --git a/hmp-commands.hx b/hmp-commands.hx
index 6fd5336..3089533 100644
--- a/hmp-commands.hx
+++ b/hmp-commands.hx
@@ -204,7 +204,6 @@ ETEXI
STEXI
@item change @var{device} @var{setting}
@findex change
-
Change the configuration of a device.
@table @option
@@ -522,7 +521,6 @@ ETEXI
STEXI
@item p or print/@var{fmt} @var{expr}
@findex print
-
Print expression value. Only the @var{format} part of @var{fmt} is
used.
ETEXI
@@ -536,6 +534,8 @@ ETEXI
},
STEXI
address@hidden i/@var{fmt} @var{addr} address@hidden
address@hidden i
Read I/O port.
ETEXI
@@ -548,6 +548,8 @@ ETEXI
},
STEXI
address@hidden o/@var{fmt} @var{addr} @var{val}
address@hidden o
Write to I/O port.
ETEXI
@@ -563,7 +565,6 @@ ETEXI
STEXI
@item sendkey @var{keys}
@findex sendkey
-
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
several keys simultaneously. Example:
@@ -586,7 +587,6 @@ ETEXI
STEXI
@item system_reset
@findex system_reset
-
Reset the system.
ETEXI
@@ -601,7 +601,6 @@ ETEXI
STEXI
@item system_powerdown
@findex system_powerdown
-
Power down the system (if supported).
ETEXI
@@ -616,7 +615,6 @@ ETEXI
STEXI
@item sum @var{addr} @var{size}
@findex sum
-
Compute the checksum of a memory region.
ETEXI
@@ -631,7 +629,6 @@ ETEXI
STEXI
@item usb_add @var{devname}
@findex usb_add
-
Add the USB device @var{devname}. For details of available devices see
@ref{usb_devices}
ETEXI
@@ -647,7 +644,6 @@ ETEXI
STEXI
@item usb_del @var{devname}
@findex usb_del
-
Remove the USB device @var{devname} from the QEMU virtual USB
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
command @code{info usb} to see the devices you can remove.
@@ -666,7 +662,6 @@ ETEXI
STEXI
@item device_add @var{config}
@findex device_add
-
Add device.
ETEXI
@@ -682,7 +677,6 @@ ETEXI
STEXI
@item device_del @var{id}
@findex device_del
-
Remove device @var{id}.
ETEXI
@@ -823,7 +817,6 @@ ETEXI
STEXI
@item boot_set @var{bootdevicelist}
@findex boot_set
-
Define new values for the boot device list. Those values will override
the values specified on the command line through the @code{-boot} option.
@@ -1538,9 +1531,9 @@ ETEXI
},
STEXI
address@hidden block_set_io_throttle @var{device} @var{bps} @var{bps_rd}
@var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
address@hidden block_set_io_throttle
-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}
address@hidden block_passwd @var{device} @var{password}
address@hidden block_passwd
+Set the encrypted device @var{device} password to @var{password}
ETEXI
{
@@ -1552,9 +1545,9 @@ ETEXI
},
STEXI
address@hidden block_passwd @var{device} @var{password}
address@hidden block_passwd
-Set the encrypted device @var{device} password to @var{password}
address@hidden block_set_io_throttle @var{device} @var{bps} @var{bps_rd}
@var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
address@hidden block_set_io_throttle
+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
{
@@ -1568,7 +1561,6 @@ ETEXI
STEXI
@item set_password [ vnc | spice ] password [ action-if-connected ]
@findex set_password
-
Change spice/vnc password. Use zero to make the password stay valid
forever. @var{action-if-connected} specifies what should happen in
case a connection is established: @var{fail} makes the password change
@@ -1588,7 +1580,6 @@ ETEXI
STEXI
@item expire_password [ vnc | spice ] expire-time
@findex expire_password
-
Specify when a password for spice/vnc becomes
invalid. @var{expire-time} accepts:
@@ -1619,9 +1610,8 @@ ETEXI
},
STEXI
address@hidden chardev_add args
address@hidden chardev_add
-
address@hidden chardev-add args
address@hidden chardev-add
chardev_add accepts the same parameters as the -chardev command line switch.
ETEXI
@@ -1636,9 +1626,8 @@ ETEXI
},
STEXI
address@hidden chardev_remove id
address@hidden chardev_remove
-
address@hidden chardev-remove id
address@hidden chardev-remove
Removes the chardev @var{id}.
ETEXI
@@ -1654,7 +1643,6 @@ ETEXI
STEXI
@item qemu-io @var{device} @var{command}
@findex qemu-io
-
Executes a qemu-io command on the given block device.
ETEXI
@@ -1669,6 +1657,7 @@ ETEXI
STEXI
@item cpu-add @var{id}
address@hidden cpu-add
Add CPU with id @var{id}
ETEXI
--
2.1.4
- [Qemu-trivial] [PULL 00/24] Trivial patches for 2015-03-19, Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 07/24] qom: Fix warning from Sparse, Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 16/24] pc-dimm: Add description for device list., Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 15/24] configure: enable kvm on x32, Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 09/24] block/qapi: Fix Sparse warning, Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 14/24] error: Replace error_report() & error_free() with error_report_err(), Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 03/24] 9pfs: Fix warnings from Sparse, Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 21/24] hmp: Fix texinfo documentation,
Michael Tokarev <=
- [Qemu-trivial] [PULL 18/24] vl: fix resource leak with monitor_fdset_add_fd, Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 24/24] qga/commands-posix: Fix resource leak, Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 08/24] Fix remaining warnings from Sparse (void return), Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 01/24] cris: remove unused cris_cond15 declarations, Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 06/24] target-mips: Fix warning from Sparse, Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 20/24] Fix typos in comments, Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 12/24] qmp: Drop unused .user_print from command definitions, Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 10/24] target-moxie: Fix warnings from Sparse (one-bit signed bitfield), Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 19/24] qtest/ahci: Fix a bit mask expression, Michael Tokarev, 2015/03/19
- [Qemu-trivial] [PULL 05/24] arm/nseries: Fix warnings from Sparse, Michael Tokarev, 2015/03/19