doc: Monitor command documentation fixes
cover doc: Monitor command documentation fixes
Markus Armbruster (4):
doc: Fix host forwarding monitor command documentation
doc: Fix acl monitor command documentation
doc: Heading for monitor command cpu got lost, restore it
doc: Clean up monitor command function index
qemu-monitor.hx | 26 +++++++++++++++++--------- 1 files changed, 17 insertions(+), 9 deletions(-)
PATCH 1/4 doc: Fix host forwarding monitor command documentation
Commit f3546deb replaced host_net_redir by hostfwd_add, hostfwd_remove, but neglected to update documentation.
--- qemu-monitor.hx | 13 ++++++++++--- 1 files changed, 10 insertions(+), 3 deletions(-)
qemu-monitor.hx +10 -3
@@ -953,7 +953,14 @@ ETEXI .help = "redirect TCP or UDP connections from host to guest (requires -net user)", .mhandler.cmd = net_slirp_hostfwd_add, }, +#endif +STEXI +@item hostfwd_add +@findex hostfwd_add +Redirect TCP or UDP connections from host to guest (requires -net user). +ETEXI +#ifdef CONFIG_SLIRP { .name = "hostfwd_remove", .args_type = "arg1:s,arg2:s?,arg3:s?",
@@ -964,9 +971,9 @@ ETEXI #endif STEXI -@item host_net_redir -@findex host_net_redir -Redirect TCP or UDP connections from host to guest (requires -net user). +@item hostfwd_remove +@findex hostfwd_remove +Remove host-to-guest TCP or UDP redirection. ETEXI {
Signature · 1 line
1.6.6.1
Anthony Liguori
AppliedRe: [Qemu-devel] [PATCH 1/4] doc: Fix host forwarding monitor command documentation
Quoted 5 lines · Markus Armbruster
Commit
f3546debreplacedhost_net_redirbyhostfwd_add,hostfwd_remove, but neglected to update documentation.Signed-off-by Markus Armbruster<[email protected]>
Applied all. Thanks.
Regards,
Anthony Liguori
Quoted 37 lines
--- qemu-monitor.hx | 13 ++++++++++--- 1 files changed, 10 insertions(+), 3 deletions(-)qemu-monitor.hx +10
-3@@ -953,7 +953,14 @@ ETEXI .help = "redirect TCP or UDP connections from host to guest (requires -net user)", .mhandler.cmd = net_slirp_hostfwd_add, }, +#endif +STEXI +@item hostfwd_add +@findex hostfwd_add +Redirect TCP or UDP connections from host to guest (requires -net user). +ETEXI +#ifdef CONFIG_SLIRP { .name = "hostfwd_remove", .args_type = "arg1:s,arg2:s?,arg3:s?",@@ -964,9 +971,9 @@ ETEXI #endif STEXI -@item host_net_redir -@findex host_net_redir -Redirect TCP or UDP connections from host to guest (requires -net user). +@item hostfwd_remove +@findex hostfwd_remove +Remove host-to-guest TCP or UDP redirection. ETEXI {
PATCH 2/4 doc: Fix acl monitor command documentation
In reply to Markus ArmbrusterCommit 15dfcd45 added acl_add and acl_reset, but fat-fingered their documentation to read acl_allow and acl_remove.
--- qemu-monitor.hx | 7 ++++--- 1 files changed, 4 insertions(+), 3 deletions(-)
qemu-monitor.hx +4 -3
@@ -1063,8 +1063,8 @@ ETEXI }, STEXI -@item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}] -@findex acl_allow +@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}] +@findex acl_add Add a match rule to the access control list, allowing or denying access. The match will normally be an exact username or x509 distinguished name, but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
@@ -1096,7 +1096,8 @@ ETEXI }, STEXI -@item acl_remove @var{aclname} +@item acl_reset @var{aclname} +@findex acl_reset Remove all matches from the access control list, and set the default policy back to @code{deny}. ETEXI
Signature · 1 line
1.6.6.1
PATCH 3/4 doc: Heading for monitor command cpu got lost, restore it
In reply to Markus ArmbrusterBroken in commit 2313086a.
--- qemu-monitor.hx | 2 ++ 1 files changed, 2 insertions(+), 0 deletions(-)
qemu-monitor.hx +2 -0
@@ -611,6 +611,8 @@ ETEXI }, STEXI +@item cpu @var{index} +@findex cpu Set the default CPU. ETEXI
Signature · 1 line
1.6.6.1
PATCH 4/4 doc: Clean up monitor command function index
In reply to Markus ArmbrusterRemove bogus entries "count", "format" and "size". Accidentally added in commit 70fcbbe7.
Add missing entry "qmp_capabilities". Was forgotten in commit 4a7e1190.
--- qemu-monitor.hx | 4 +--- 1 files changed, 1 insertions(+), 3 deletions(-)
qemu-monitor.hx +1 -3
@@ -374,16 +374,13 @@ data. Its syntax is: @option{/@{count@}@{format@}@{size@}} @table @var @item count -@findex count is the number of items to be dumped. @item format -@findex format can be x (hex), d (signed decimal), u (unsigned decimal), o (octal), c (char) or i (asm instruction). @item size -@findex size can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86, @code{h} or @code{w} can be specified with the @code{i} format to respectively select 16 or 32 bit code instruction size.
@@ -1181,6 +1178,7 @@ ETEXI STEXI @item qmp_capabilities +@findex qmp_capabilities Enable the specified QMP capabilities ETEXI
Signature · 1 line
1.6.6.1
Quoted 8 lines · On Tue, 4 May 2010 13:20:29 +0200 Markus Armbruster <[email protected]> wrote:
Markus Armbruster (4):
doc: Fix host forwarding monitor command documentation
doc: Fix acl monitor command documentation
doc: Heading for monitor command cpu got lost, restore it
doc: Clean up monitor command function indexqemu-monitor.hx | 26 +++++++++++++++++--------- 1 files changed, 17 insertions(+), 9 deletions(-)
Looks good to me.