[PATCH 28/32] docs: formatdomain-devices: Split out <panic>

Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/formatdomain-devices-panic.rst | 44 +++++++++++++++++++++++++++ docs/formatdomain-devices.rst | 46 +---------------------------- docs/meson.build | 1 + 3 files changed, 46 insertions(+), 45 deletions(-) create mode 100644 docs/formatdomain-devices-panic.rst diff --git a/docs/formatdomain-devices-panic.rst b/docs/formatdomain-devices-panic.rst new file mode 100644 index 0000000000..e0a2829e6c --- /dev/null +++ b/docs/formatdomain-devices-panic.rst @@ -0,0 +1,44 @@ +:anchor:`<a id="elementsPanic"/>` + +panic device +~~~~~~~~~~~~ + +panic device enables libvirt to receive panic notification from a QEMU guest. +:since:`Since 1.2.1, QEMU and KVM only` + +This feature is always enabled for: + +- pSeries guests, since it's implemented by the guest firmware +- S390 guests, since it's an integral part of the S390 architecture + +For the guest types listed above, libvirt automatically adds a ``panic`` element +to the domain XML. + +Example: usage of panic configuration + +:: + + ... + <devices> + <panic model='hyperv'/> + <panic model='isa'> + <address type='isa' iobase='0x505'/> + </panic> + </devices> + ... + +``model`` + The optional ``model`` attribute specifies what type of panic device is + provided. The panic model used when this attribute is missing depends on the + hypervisor and guest arch. + + - 'isa' - for ISA pvpanic device + - 'pseries' - default and valid only for pSeries guests. + - 'hyperv' - for Hyper-V crash CPU feature. :since:`Since 1.3.0, QEMU and + KVM only` + - 's390' - default for S390 guests. :since:`Since 1.3.5` + +``address`` + address of panic. The default ioport is 0x505. Most users don't need to + specify an address, and doing so is forbidden altogether for s390, pseries + and hyperv models. diff --git a/docs/formatdomain-devices.rst b/docs/formatdomain-devices.rst index ce4c44af05..b629f128bc 100644 --- a/docs/formatdomain-devices.rst +++ b/docs/formatdomain-devices.rst @@ -60,51 +60,7 @@ following characters: ``[a-zA-Z0-9_-]``. :since:`Since 3.9.0` .. include:: formatdomain-devices-rng.rst .. include:: formatdomain-devices-tpm.rst .. include:: formatdomain-devices-nvram.rst - -:anchor:`<a id="elementsPanic"/>` - -panic device -~~~~~~~~~~~~ - -panic device enables libvirt to receive panic notification from a QEMU guest. -:since:`Since 1.2.1, QEMU and KVM only` - -This feature is always enabled for: - -- pSeries guests, since it's implemented by the guest firmware -- S390 guests, since it's an integral part of the S390 architecture - -For the guest types listed above, libvirt automatically adds a ``panic`` element -to the domain XML. - -Example: usage of panic configuration - -:: - - ... - <devices> - <panic model='hyperv'/> - <panic model='isa'> - <address type='isa' iobase='0x505'/> - </panic> - </devices> - ... - -``model`` - The optional ``model`` attribute specifies what type of panic device is - provided. The panic model used when this attribute is missing depends on the - hypervisor and guest arch. - - - 'isa' - for ISA pvpanic device - - 'pseries' - default and valid only for pSeries guests. - - 'hyperv' - for Hyper-V crash CPU feature. :since:`Since 1.3.0, QEMU and - KVM only` - - 's390' - default for S390 guests. :since:`Since 1.3.5` - -``address`` - address of panic. The default ioport is 0x505. Most users don't need to - specify an address, and doing so is forbidden altogether for s390, pseries - and hyperv models. +.. include:: formatdomain-devices-panic.rst :anchor:`<a id="elementsShmem"/>` diff --git a/docs/meson.build b/docs/meson.build index 73f413cd91..e8373ff2c7 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -145,6 +145,7 @@ docs_rst_files = [ 'formatdomain-devices-rng.rst', 'formatdomain-devices-tpm.rst', 'formatdomain-devices-nvram.rst', + 'formatdomain-devices-panic.rst', ] }, { 'name': 'hacking' }, -- 2.26.2