X-Git-Url: http://git.ipfire.org/?a=blobdiff_plain;f=hmp-commands-info.hx;h=499d6d54b018058685e2f573af97749bd117f33a;hb=aab613fb9597015b39bdc90da3ee80c0da05b927;hp=c59444c4616d52bc0368e3aff97ecbc07009a4dd;hpb=f4b2c02a2911b164474b998532b1a963fc9b785b;p=thirdparty%2Fqemu.git

diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
index c59444c4616..499d6d54b01 100644
--- a/hmp-commands-info.hx
+++ b/hmp-commands-info.hx
@@ -4,14 +4,18 @@ HXCOMM discarded from C version
 HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
 HXCOMM monitor info commands
 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
+HXCOMM
+HXCOMM In this file, generally SRST fragments should have two extra
+HXCOMM spaces of indent, so that the documentation list item for "info foo"
+HXCOMM appears inside the documentation list item for the top level
+HXCOMM "info" documentation entry. The exception is the first SRST
+HXCOMM fragment that defines that top level entry.
 
-STEXI
-@table @option
-@item info @var{subcommand}
-@findex info
-Show various information about the system state.
-@table @option
-ETEXI
+SRST
+``info`` *subcommand*
+  Show various information about the system state.
+
+ERST
 
     {
         .name       = "version",
@@ -22,11 +26,10 @@ ETEXI
         .flags      = "p",
     },
 
-STEXI
-@item info version
-@findex info version
-Show the version of QEMU.
-ETEXI
+SRST
+  ``info version``
+    Show the version of QEMU.
+ERST
 
     {
         .name       = "network",
@@ -36,11 +39,10 @@ ETEXI
         .cmd        = hmp_info_network,
     },
 
-STEXI
-@item info network
-@findex info network
-Show the network state.
-ETEXI
+SRST
+  ``info network``
+    Show the network state.
+ERST
 
     {
         .name       = "chardev",
@@ -51,11 +53,10 @@ ETEXI
         .flags      = "p",
     },
 
-STEXI
-@item info chardev
-@findex info chardev
-Show the character devices.
-ETEXI
+SRST
+  ``info chardev``
+    Show the character devices.
+ERST
 
     {
         .name       = "block",
@@ -66,11 +67,10 @@ ETEXI
         .cmd        = hmp_info_block,
     },
 
-STEXI
-@item info block
-@findex info block
-Show info of one block device or all block devices.
-ETEXI
+SRST
+  ``info block``
+    Show info of one block device or all block devices.
+ERST
 
     {
         .name       = "blockstats",
@@ -80,11 +80,10 @@ ETEXI
         .cmd        = hmp_info_blockstats,
     },
 
-STEXI
-@item info blockstats
-@findex info blockstats
-Show block device statistics.
-ETEXI
+SRST
+  ``info blockstats``
+    Show block device statistics.
+ERST
 
     {
         .name       = "block-jobs",
@@ -94,11 +93,10 @@ ETEXI
         .cmd        = hmp_info_block_jobs,
     },
 
-STEXI
-@item info block-jobs
-@findex info block-jobs
-Show progress of ongoing block device operations.
-ETEXI
+SRST
+  ``info block-jobs``
+    Show progress of ongoing block device operations.
+ERST
 
     {
         .name       = "registers",
@@ -108,11 +106,10 @@ ETEXI
         .cmd        = hmp_info_registers,
     },
 
-STEXI
-@item info registers
-@findex info registers
-Show the cpu registers.
-ETEXI
+SRST
+  ``info registers``
+    Show the cpu registers.
+ERST
 
 #if defined(TARGET_I386)
     {
@@ -125,11 +122,10 @@ ETEXI
     },
 #endif
 
-STEXI
-@item info lapic
-@findex info lapic
-Show local APIC state
-ETEXI
+SRST
+  ``info lapic``
+    Show local APIC state
+ERST
 
 #if defined(TARGET_I386)
     {
@@ -141,11 +137,10 @@ ETEXI
     },
 #endif
 
-STEXI
-@item info ioapic
-@findex info ioapic
-Show io APIC state
-ETEXI
+SRST
+  ``info ioapic``
+    Show io APIC state
+ERST
 
     {
         .name       = "cpus",
@@ -155,11 +150,10 @@ ETEXI
         .cmd        = hmp_info_cpus,
     },
 
-STEXI
-@item info cpus
-@findex info cpus
-Show infos for each CPU.
-ETEXI
+SRST
+  ``info cpus``
+    Show infos for each CPU.
+ERST
 
     {
         .name       = "history",
@@ -170,11 +164,10 @@ ETEXI
         .flags      = "p",
     },
 
-STEXI
-@item info history
-@findex info history
-Show the command line history.
-ETEXI
+SRST
+  ``info history``
+    Show the command line history.
+ERST
 
     {
         .name       = "irq",
@@ -184,11 +177,10 @@ ETEXI
         .cmd        = hmp_info_irq,
     },
 
-STEXI
-@item info irq
-@findex info irq
-Show the interrupts statistics (if available).
-ETEXI
+SRST
+  ``info irq``
+    Show the interrupts statistics (if available).
+ERST
 
     {
         .name       = "pic",
@@ -198,11 +190,10 @@ ETEXI
         .cmd        = hmp_info_pic,
     },
 
-STEXI
-@item info pic
-@findex info pic
-Show PIC state.
-ETEXI
+SRST
+  ``info pic``
+    Show PIC state.
+ERST
 
     {
         .name       = "rdma",
@@ -212,11 +203,10 @@ ETEXI
         .cmd        = hmp_info_rdma,
     },
 
-STEXI
-@item info rdma
-@findex info rdma
-Show RDMA state.
-ETEXI
+SRST
+  ``info rdma``
+    Show RDMA state.
+ERST
 
     {
         .name       = "pci",
@@ -226,11 +216,10 @@ ETEXI
         .cmd        = hmp_info_pci,
     },
 
-STEXI
-@item info pci
-@findex info pci
-Show PCI information.
-ETEXI
+SRST
+  ``info pci``
+    Show PCI information.
+ERST
 
 #if defined(TARGET_I386) || defined(TARGET_SH4) || defined(TARGET_SPARC) || \
     defined(TARGET_PPC) || defined(TARGET_XTENSA) || defined(TARGET_M68K)
@@ -243,13 +232,12 @@ ETEXI
     },
 #endif
 
-STEXI
-@item info tlb
-@findex info tlb
-Show virtual to physical memory mappings.
-ETEXI
+SRST
+  ``info tlb``
+    Show virtual to physical memory mappings.
+ERST
 
-#if defined(TARGET_I386)
+#if defined(TARGET_I386) || defined(TARGET_RISCV)
     {
         .name       = "mem",
         .args_type  = "",
@@ -259,11 +247,10 @@ ETEXI
     },
 #endif
 
-STEXI
-@item info mem
-@findex info mem
-Show the active virtual memory mappings.
-ETEXI
+SRST
+  ``info mem``
+    Show the active virtual memory mappings.
+ERST
 
     {
         .name       = "mtree",
@@ -275,11 +262,10 @@ ETEXI
         .cmd        = hmp_info_mtree,
     },
 
-STEXI
-@item info mtree
-@findex info mtree
-Show memory tree.
-ETEXI
+SRST
+  ``info mtree``
+    Show memory tree.
+ERST
 
 #if defined(CONFIG_TCG)
     {
@@ -291,11 +277,10 @@ ETEXI
     },
 #endif
 
-STEXI
-@item info jit
-@findex info jit
-Show dynamic compiler info.
-ETEXI
+SRST
+  ``info jit``
+    Show dynamic compiler info.
+ERST
 
 #if defined(CONFIG_TCG)
     {
@@ -307,11 +292,10 @@ ETEXI
     },
 #endif
 
-STEXI
-@item info opcount
-@findex info opcount
-Show dynamic compiler opcode counters
-ETEXI
+SRST
+  ``info opcount``
+    Show dynamic compiler opcode counters
+ERST
 
     {
         .name       = "sync-profile",
@@ -324,16 +308,20 @@ ETEXI
         .cmd        = hmp_info_sync_profile,
     },
 
-STEXI
-@item info sync-profile [-m|-n] [@var{max}]
-@findex info sync-profile
-Show synchronization profiling info, up to @var{max} entries (default: 10),
-sorted by total wait time.
-        -m: sort by mean wait time
-        -n: do not coalesce objects with the same call site
-When different objects that share the same call site are coalesced, the "Object"
-field shows---enclosed in brackets---the number of objects being coalesced.
-ETEXI
+SRST
+  ``info sync-profile [-m|-n]`` [*max*]
+    Show synchronization profiling info, up to *max* entries (default: 10),
+    sorted by total wait time.
+
+    ``-m``
+      sort by mean wait time
+    ``-n``
+      do not coalesce objects with the same call site
+
+    When different objects that share the same call site are coalesced,
+    the "Object" field shows---enclosed in brackets---the number of objects
+    being coalesced.
+ERST
 
     {
         .name       = "kvm",
@@ -343,11 +331,10 @@ ETEXI
         .cmd        = hmp_info_kvm,
     },
 
-STEXI
-@item info kvm
-@findex info kvm
-Show KVM information.
-ETEXI
+SRST
+  ``info kvm``
+    Show KVM information.
+ERST
 
     {
         .name       = "numa",
@@ -357,11 +344,10 @@ ETEXI
         .cmd        = hmp_info_numa,
     },
 
-STEXI
-@item info numa
-@findex info numa
-Show NUMA information.
-ETEXI
+SRST
+  ``info numa``
+    Show NUMA information.
+ERST
 
     {
         .name       = "usb",
@@ -371,11 +357,10 @@ ETEXI
         .cmd        = hmp_info_usb,
     },
 
-STEXI
-@item info usb
-@findex info usb
-Show guest USB devices.
-ETEXI
+SRST
+  ``info usb``
+    Show guest USB devices.
+ERST
 
     {
         .name       = "usbhost",
@@ -385,11 +370,10 @@ ETEXI
         .cmd        = hmp_info_usbhost,
     },
 
-STEXI
-@item info usbhost
-@findex info usbhost
-Show host USB devices.
-ETEXI
+SRST
+  ``info usbhost``
+    Show host USB devices.
+ERST
 
     {
         .name       = "profile",
@@ -399,11 +383,10 @@ ETEXI
         .cmd        = hmp_info_profile,
     },
 
-STEXI
-@item info profile
-@findex info profile
-Show profiling information.
-ETEXI
+SRST
+  ``info profile``
+    Show profiling information.
+ERST
 
     {
         .name       = "capture",
@@ -413,11 +396,10 @@ ETEXI
         .cmd        = hmp_info_capture,
     },
 
-STEXI
-@item info capture
-@findex info capture
-Show capture information.
-ETEXI
+SRST
+  ``info capture``
+    Show capture information.
+ERST
 
     {
         .name       = "snapshots",
@@ -427,11 +409,10 @@ ETEXI
         .cmd        = hmp_info_snapshots,
     },
 
-STEXI
-@item info snapshots
-@findex info snapshots
-Show the currently saved VM snapshots.
-ETEXI
+SRST
+  ``info snapshots``
+    Show the currently saved VM snapshots.
+ERST
 
     {
         .name       = "status",
@@ -442,11 +423,10 @@ ETEXI
         .flags      = "p",
     },
 
-STEXI
-@item info status
-@findex info status
-Show the current VM status (running|paused).
-ETEXI
+SRST
+  ``info status``
+    Show the current VM status (running|paused).
+ERST
 
     {
         .name       = "mice",
@@ -456,11 +436,10 @@ ETEXI
         .cmd        = hmp_info_mice,
     },
 
-STEXI
-@item info mice
-@findex info mice
-Show which guest mouse is receiving events.
-ETEXI
+SRST
+  ``info mice``
+    Show which guest mouse is receiving events.
+ERST
 
 #if defined(CONFIG_VNC)
     {
@@ -472,11 +451,10 @@ ETEXI
     },
 #endif
 
-STEXI
-@item info vnc
-@findex info vnc
-Show the vnc server status.
-ETEXI
+SRST
+  ``info vnc``
+    Show the vnc server status.
+ERST
 
 #if defined(CONFIG_SPICE)
     {
@@ -488,11 +466,10 @@ ETEXI
     },
 #endif
 
-STEXI
-@item info spice
-@findex info spice
-Show the spice server status.
-ETEXI
+SRST
+  ``info spice``
+    Show the spice server status.
+ERST
 
     {
         .name       = "name",
@@ -503,11 +480,10 @@ ETEXI
         .flags      = "p",
     },
 
-STEXI
-@item info name
-@findex info name
-Show the current VM name.
-ETEXI
+SRST
+  ``info name``
+    Show the current VM name.
+ERST
 
     {
         .name       = "uuid",
@@ -518,11 +494,10 @@ ETEXI
         .flags      = "p",
     },
 
-STEXI
-@item info uuid
-@findex info uuid
-Show the current VM UUID.
-ETEXI
+SRST
+  ``info uuid``
+    Show the current VM UUID.
+ERST
 
     {
         .name       = "cpustats",
@@ -532,11 +507,10 @@ ETEXI
         .cmd        = hmp_info_cpustats,
     },
 
-STEXI
-@item info cpustats
-@findex info cpustats
-Show CPU statistics.
-ETEXI
+SRST
+  ``info cpustats``
+    Show CPU statistics.
+ERST
 
 #if defined(CONFIG_SLIRP)
     {
@@ -548,11 +522,10 @@ ETEXI
     },
 #endif
 
-STEXI
-@item info usernet
-@findex info usernet
-Show user network stack connection states.
-ETEXI
+SRST
+  ``info usernet``
+    Show user network stack connection states.
+ERST
 
     {
         .name       = "migrate",
@@ -562,11 +535,10 @@ ETEXI
         .cmd        = hmp_info_migrate,
     },
 
-STEXI
-@item info migrate
-@findex info migrate
-Show migration status.
-ETEXI
+SRST
+  ``info migrate``
+    Show migration status.
+ERST
 
     {
         .name       = "migrate_capabilities",
@@ -576,11 +548,10 @@ ETEXI
         .cmd        = hmp_info_migrate_capabilities,
     },
 
-STEXI
-@item info migrate_capabilities
-@findex info migrate_capabilities
-Show current migration capabilities.
-ETEXI
+SRST
+  ``info migrate_capabilities``
+    Show current migration capabilities.
+ERST
 
     {
         .name       = "migrate_parameters",
@@ -590,11 +561,10 @@ ETEXI
         .cmd        = hmp_info_migrate_parameters,
     },
 
-STEXI
-@item info migrate_parameters
-@findex info migrate_parameters
-Show current migration parameters.
-ETEXI
+SRST
+  ``info migrate_parameters``
+    Show current migration parameters.
+ERST
 
     {
         .name       = "migrate_cache_size",
@@ -604,11 +574,10 @@ ETEXI
         .cmd        = hmp_info_migrate_cache_size,
     },
 
-STEXI
-@item info migrate_cache_size
-@findex info migrate_cache_size
-Show current migration xbzrle cache size.
-ETEXI
+SRST
+  ``info migrate_cache_size``
+    Show current migration xbzrle cache size.
+ERST
 
     {
         .name       = "balloon",
@@ -618,11 +587,10 @@ ETEXI
         .cmd        = hmp_info_balloon,
     },
 
-STEXI
-@item info balloon
-@findex info balloon
-Show balloon information.
-ETEXI
+SRST
+  ``info balloon``
+    Show balloon information.
+ERST
 
     {
         .name       = "qtree",
@@ -632,11 +600,10 @@ ETEXI
         .cmd        = hmp_info_qtree,
     },
 
-STEXI
-@item info qtree
-@findex info qtree
-Show device tree.
-ETEXI
+SRST
+  ``info qtree``
+    Show device tree.
+ERST
 
     {
         .name       = "qdm",
@@ -646,11 +613,10 @@ ETEXI
         .cmd        = hmp_info_qdm,
     },
 
-STEXI
-@item info qdm
-@findex info qdm
-Show qdev device model list.
-ETEXI
+SRST
+  ``info qdm``
+    Show qdev device model list.
+ERST
 
     {
         .name       = "qom-tree",
@@ -661,11 +627,10 @@ ETEXI
         .flags      = "p",
     },
 
-STEXI
-@item info qom-tree
-@findex info qom-tree
-Show QOM composition tree.
-ETEXI
+SRST
+  ``info qom-tree``
+    Show QOM composition tree.
+ERST
 
     {
         .name       = "roms",
@@ -675,11 +640,10 @@ ETEXI
         .cmd        = hmp_info_roms,
     },
 
-STEXI
-@item info roms
-@findex info roms
-Show roms.
-ETEXI
+SRST
+  ``info roms``
+    Show roms.
+ERST
 
     {
         .name       = "trace-events",
@@ -691,11 +655,10 @@ ETEXI
         .command_completion = info_trace_events_completion,
     },
 
-STEXI
-@item info trace-events
-@findex info trace-events
-Show available trace-events & their state.
-ETEXI
+SRST
+  ``info trace-events``
+    Show available trace-events & their state.
+ERST
 
     {
         .name       = "tpm",
@@ -705,11 +668,10 @@ ETEXI
         .cmd        = hmp_info_tpm,
     },
 
-STEXI
-@item info tpm
-@findex info tpm
-Show the TPM device.
-ETEXI
+SRST
+  ``info tpm``
+    Show the TPM device.
+ERST
 
     {
         .name       = "memdev",
@@ -720,11 +682,10 @@ ETEXI
         .flags      = "p",
     },
 
-STEXI
-@item info memdev
-@findex info memdev
-Show memory backends
-ETEXI
+SRST
+  ``info memdev``
+    Show memory backends
+ERST
 
     {
         .name       = "memory-devices",
@@ -734,11 +695,10 @@ ETEXI
         .cmd        = hmp_info_memory_devices,
     },
 
-STEXI
-@item info memory-devices
-@findex info memory-devices
-Show memory devices.
-ETEXI
+SRST
+  ``info memory-devices``
+    Show memory devices.
+ERST
 
     {
         .name       = "iothreads",
@@ -749,11 +709,10 @@ ETEXI
         .flags      = "p",
     },
 
-STEXI
-@item info iothreads
-@findex info iothreads
-Show iothread's identifiers.
-ETEXI
+SRST
+  ``info iothreads``
+    Show iothread's identifiers.
+ERST
 
     {
         .name       = "rocker",
@@ -763,11 +722,10 @@ ETEXI
         .cmd        = hmp_rocker,
     },
 
-STEXI
-@item info rocker @var{name}
-@findex info rocker
-Show rocker switch.
-ETEXI
+SRST
+  ``info rocker`` *name*
+    Show rocker switch.
+ERST
 
     {
         .name       = "rocker-ports",
@@ -777,11 +735,10 @@ ETEXI
         .cmd        = hmp_rocker_ports,
     },
 
-STEXI
-@item info rocker-ports @var{name}-ports
-@findex info rocker-ports
-Show rocker ports.
-ETEXI
+SRST
+  ``info rocker-ports`` *name*-ports
+    Show rocker ports.
+ERST
 
     {
         .name       = "rocker-of-dpa-flows",
@@ -791,11 +748,10 @@ ETEXI
         .cmd        = hmp_rocker_of_dpa_flows,
     },
 
-STEXI
-@item info rocker-of-dpa-flows @var{name} [@var{tbl_id}]
-@findex info rocker-of-dpa-flows
-Show rocker OF-DPA flow tables.
-ETEXI
+SRST
+  ``info rocker-of-dpa-flows`` *name* [*tbl_id*]
+    Show rocker OF-DPA flow tables.
+ERST
 
     {
         .name       = "rocker-of-dpa-groups",
@@ -805,11 +761,10 @@ ETEXI
         .cmd        = hmp_rocker_of_dpa_groups,
     },
 
-STEXI
-@item info rocker-of-dpa-groups @var{name} [@var{type}]
-@findex info rocker-of-dpa-groups
-Show rocker OF-DPA groups.
-ETEXI
+SRST
+  ``info rocker-of-dpa-groups`` *name* [*type*]
+    Show rocker OF-DPA groups.
+ERST
 
 #if defined(TARGET_S390X)
     {
@@ -821,11 +776,10 @@ ETEXI
     },
 #endif
 
-STEXI
-@item info skeys @var{address}
-@findex info skeys
-Display the value of a storage key (s390 only)
-ETEXI
+SRST
+  ``info skeys`` *address*
+    Display the value of a storage key (s390 only)
+ERST
 
 #if defined(TARGET_S390X)
     {
@@ -837,11 +791,11 @@ ETEXI
     },
 #endif
 
-STEXI
-@item info cmma @var{address}
-@findex info cmma
-Display the values of the CMMA storage attributes for a range of pages (s390 only)
-ETEXI
+SRST
+  ``info cmma`` *address*
+    Display the values of the CMMA storage attributes for a range of
+    pages (s390 only)
+ERST
 
     {
         .name       = "dump",
@@ -851,11 +805,10 @@ ETEXI
         .cmd        = hmp_info_dump,
     },
 
-STEXI
-@item info dump
-@findex info dump
-Display the latest dump status.
-ETEXI
+SRST
+  ``info dump``
+    Display the latest dump status.
+ERST
 
     {
         .name       = "ramblock",
@@ -865,11 +818,10 @@ ETEXI
         .cmd        = hmp_info_ramblock,
     },
 
-STEXI
-@item info ramblock
-@findex info ramblock
-Dump all the ramblocks of the system.
-ETEXI
+SRST
+  ``info ramblock``
+    Dump all the ramblocks of the system.
+ERST
 
     {
         .name       = "hotpluggable-cpus",
@@ -880,11 +832,10 @@ ETEXI
         .flags      = "p",
     },
 
-STEXI
-@item info hotpluggable-cpus
-@findex info hotpluggable-cpus
-Show information about hotpluggable CPUs
-ETEXI
+SRST
+  ``info hotpluggable-cpus``
+    Show information about hotpluggable CPUs
+ERST
 
     {
         .name       = "vm-generation-id",
@@ -894,11 +845,10 @@ ETEXI
         .cmd = hmp_info_vm_generation_id,
     },
 
-STEXI
-@item info vm-generation-id
-@findex info vm-generation-id
-Show Virtual Machine Generation ID
-ETEXI
+SRST
+  ``info vm-generation-id``
+    Show Virtual Machine Generation ID
+ERST
 
     {
         .name       = "memory_size_summary",
@@ -909,12 +859,11 @@ ETEXI
         .cmd        = hmp_info_memory_size_summary,
     },
 
-STEXI
-@item info memory_size_summary
-@findex info memory_size_summary
-Display the amount of initially allocated and present hotpluggable (if
-enabled) memory in bytes.
-ETEXI
+SRST
+  ``info memory_size_summary``
+    Display the amount of initially allocated and present hotpluggable (if
+    enabled) memory in bytes.
+ERST
 
 #if defined(TARGET_I386)
     {
@@ -926,16 +875,9 @@ ETEXI
     },
 #endif
 
-STEXI
-@item info sev
-@findex info sev
-Show SEV information.
-ETEXI
+SRST
+  ``info sev``
+    Show SEV information.
+ERST
 
-STEXI
-@end table
-ETEXI
 
-STEXI
-@end table
-ETEXI