[PATCH 27/32] docs: formatdomain-devices: Split out <nvram>

Peter Krempa pkrempa at redhat.com
Thu Jul 23 13:21:32 UTC 2020


Signed-off-by: Peter Krempa <pkrempa at redhat.com>
---
 docs/formatdomain-devices-nvram.rst | 26 ++++++++++++++++++++++++++
 docs/formatdomain-devices.rst       | 28 +---------------------------
 docs/meson.build                    |  1 +
 3 files changed, 28 insertions(+), 27 deletions(-)
 create mode 100644 docs/formatdomain-devices-nvram.rst

diff --git a/docs/formatdomain-devices-nvram.rst b/docs/formatdomain-devices-nvram.rst
new file mode 100644
index 0000000000..1c9f4f34c0
--- /dev/null
+++ b/docs/formatdomain-devices-nvram.rst
@@ -0,0 +1,26 @@
+:anchor:`<a id="elementsNVRAM"/>`
+
+NVRAM device
+~~~~~~~~~~~~
+
+nvram device is always added to pSeries guest on PPC64, and its address is
+allowed to be changed. Element ``nvram`` (only valid for pSeries guest,
+:since:`since 1.0.5` ) is provided to enable the address setting.
+
+Example: usage of NVRAM configuration
+
+::
+
+   ...
+   <devices>
+     <nvram>
+       <address type='spapr-vio' reg='0x00003000'/>
+     </nvram>
+   </devices>
+   ...
+
+``spapr-vio``
+   VIO device address type, only valid for PPC64.
+
+``reg``
+   Device address
diff --git a/docs/formatdomain-devices.rst b/docs/formatdomain-devices.rst
index cf7cbc40fc..ce4c44af05 100644
--- a/docs/formatdomain-devices.rst
+++ b/docs/formatdomain-devices.rst
@@ -59,33 +59,7 @@ following characters: ``[a-zA-Z0-9_-]``. :since:`Since 3.9.0`
 .. include:: formatdomain-devices-memballoon.rst
 .. include:: formatdomain-devices-rng.rst
 .. include:: formatdomain-devices-tpm.rst
-
-:anchor:`<a id="elementsNVRAM"/>`
-
-NVRAM device
-~~~~~~~~~~~~
-
-nvram device is always added to pSeries guest on PPC64, and its address is
-allowed to be changed. Element ``nvram`` (only valid for pSeries guest,
-:since:`since 1.0.5` ) is provided to enable the address setting.
-
-Example: usage of NVRAM configuration
-
-::
-
-   ...
-   <devices>
-     <nvram>
-       <address type='spapr-vio' reg='0x00003000'/>
-     </nvram>
-   </devices>
-   ...
-
-``spapr-vio``
-   VIO device address type, only valid for PPC64.
-
-``reg``
-   Device address
+.. include:: formatdomain-devices-nvram.rst

 :anchor:`<a id="elementsPanic"/>`

diff --git a/docs/meson.build b/docs/meson.build
index d99a85422b..73f413cd91 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -144,6 +144,7 @@ docs_rst_files = [
                   'formatdomain-devices-memballoon.rst',
                   'formatdomain-devices-rng.rst',
                   'formatdomain-devices-tpm.rst',
+                  'formatdomain-devices-nvram.rst',
                 ]
   },
   { 'name': 'hacking' },
-- 
2.26.2




More information about the libvir-list mailing list