Re: [PATCH v2 09/10] docs: Provide a nodedev driver stub documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Apr 20, 2017 at 03:05:59PM +0200, Erik Skultety wrote:
There's lot more to document about the nodedev driver, besides PCI and
SR-IOV (even this might need to be extended), but let's start small-ish
and at least have a page for it linked from the drivers.html.

Signed-off-by: Erik Skultety <eskultet@xxxxxxxxxx>
---
docs/drivers.html.in    |   6 +-
docs/drvnodedev.html.in | 184 ++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 189 insertions(+), 1 deletion(-)
create mode 100644 docs/drvnodedev.html.in


diff --git a/docs/drvnodedev.html.in b/docs/drvnodedev.html.in
new file mode 100644
index 000000000..ed185c3df
--- /dev/null
+++ b/docs/drvnodedev.html.in
@@ -0,0 +1,184 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml";>
+  <body>
+    <h1>Host device management</h1>
+
+    <p>
+      Libvirt provides management of both physical and virtual host devices
+      (historically also referred to as node devices) like USB, PCI, SCSI, and
+      network devices. This also includes various virtualization capabilities
+      which the aforementioned devices provide for utilization, for example
+      SR-IOV, NPIV, MDEV, DRM, etc. <br/>
+      <br/>
+      The node device driver provides means to list and show details about host
+      devices (<code>virsh nodedev-list</code>,
+      <code>virsh nodedev-dumpxml</code>), which are generic and can be used
+      with all devices. It also provides means to create and destroy devices
+      (<code>virsh nodedev-create</code>, <code>virsh nodedev-destroy</code>)
+      which are meant to be used to create virtual devices, currently only
+      supported by NPIV
+      (<a href="http://wiki.libvirt.org/page/NPIV_in_libvirt";>more info about NPIV)</a>). <br/>
                                                                                   ^
Extra parenthesis ------------------------------------------------------------------'

Jan

+      <br/>
+      Devices on the host system are arranged in a tree-like hierarchy, with
+      the root node being called <code>computer</code>. The node device driver
+      supports two backends to manage the devices, HAL and udev, with the former
+      being deprecated in favour of the latter.<br/>

Attachment: signature.asc
Description: Digital signature

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list

[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]
  Powered by Linux