[PATCH 18/32] docs: formatdomain-devices: Split out <hub>

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


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

diff --git a/docs/formatdomain-devices-hub.rst b/docs/formatdomain-devices-hub.rst
new file mode 100644
index 0000000000..70a90fa45f
--- /dev/null
+++ b/docs/formatdomain-devices-hub.rst
@@ -0,0 +1,23 @@
+:anchor:`<a id="elementsHub"/>`
+
+Hub devices
+~~~~~~~~~~~
+
+A hub is a device that expands a single port into several so that there are more
+ports available to connect devices to a host system.
+
+::
+
+   ...
+   <devices>
+     <hub type='usb'/>
+   </devices>
+   ...
+
+``hub``
+   The ``hub`` element has one mandatory attribute, the ``type`` whose value can
+   only be 'usb'.
+
+The ``hub`` element has an optional sub-element ``<address>`` with
+``type='usb'``\ which can tie the device to a particular controller, `documented
+above <#elementsAddress>`__.
diff --git a/docs/formatdomain-devices.rst b/docs/formatdomain-devices.rst
index 5c210ffe09..5d2cca26af 100644
--- a/docs/formatdomain-devices.rst
+++ b/docs/formatdomain-devices.rst
@@ -50,30 +50,7 @@ following characters: ``[a-zA-Z0-9_-]``. :since:`Since 3.9.0`
 .. include:: formatdomain-devices-smartcard.rst
 .. include:: formatdomain-devices-interface.rst
 .. include:: formatdomain-devices-input.rst
-
-:anchor:`<a id="elementsHub"/>`
-
-Hub devices
-~~~~~~~~~~~
-
-A hub is a device that expands a single port into several so that there are more
-ports available to connect devices to a host system.
-
-::
-
-   ...
-   <devices>
-     <hub type='usb'/>
-   </devices>
-   ...
-
-``hub``
-   The ``hub`` element has one mandatory attribute, the ``type`` whose value can
-   only be 'usb'.
-
-The ``hub`` element has an optional sub-element ``<address>`` with
-``type='usb'``\ which can tie the device to a particular controller, `documented
-above <#elementsAddress>`__.
+.. include:: formatdomain-devices-hub.rst

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

diff --git a/docs/meson.build b/docs/meson.build
index 1484be45df..8657a57632 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -135,6 +135,7 @@ docs_rst_files = [
                   'formatdomain-devices-smartcard.rst',
                   'formatdomain-devices-interface.rst',
                   'formatdomain-devices-input.rst',
+                  'formatdomain-devices-hub.rst',
                 ]
   },
   { 'name': 'hacking' },
-- 
2.26.2




More information about the libvir-list mailing list