libvirt/docs
Jonathon Jongsma ed783e5ecd docs: note node device fields that are read-only
As noted by Erik Skultety, we use the same XML schema to report
existing devices and to define new devices. However, some schema
elements are "read-only". In other words, they are used to report
information from the node device driver and cannot be used to define a
new device. Note these in the documentation.

Signed-off-by: Jonathon Jongsma <jjongsma@redhat.com>
Reviewed-by: Erik Skultety <eskultet@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-06-19 10:39:55 +02:00
..
fonts Convert all remaining Markdown files to reStructuredText 2020-04-14 16:29:04 +02:00
gitdm gitdm: Add missing entries 2020-06-04 12:06:08 +02:00
html
internals virCommand: Actually acquire pidfile instead of just writing it 2020-03-24 15:44:23 +01:00
js docs: Fix Blog Planet links 2019-06-20 17:01:44 +02:00
kbase docs: Describe protected virtualization guest setup 2020-06-16 09:43:45 +02:00
logos docs: add SVGs for sticker logos 2019-08-29 12:46:33 +01:00
manpages manpages/virsh.rst: clarify numatune memory migration on Linux 2020-06-16 14:06:37 +02:00
schemas nodedev: add support for mdev attributes 2020-06-19 10:39:54 +02:00
404.html.in Use https:// links for most sites 2017-10-16 10:22:34 +01:00
acl.html.in docs: switch to using HTML5 doctype declaration 2017-08-02 17:00:11 +01:00
aclpolkit.html.in docs: point to GitLab as the primary git hosting 2020-06-03 13:38:33 +02:00
advanced-tests.rst docs: Add advanced-tests.rst 2020-04-08 09:32:39 +02:00
android-chrome-192x192.png docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
android-chrome-256x256.png docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
api_extension.html.in docs: Make anchors follow HTML5 2019-08-28 13:39:26 +02:00
api.html.in Remove phyp driver 2019-12-20 12:25:42 -05:00
apple-touch-icon.png docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
apps.html.in docs: fixing typos 'libivrt' > 'libvirt' 2020-01-17 16:44:31 +01:00
architecture.fig
architecture.gif
architecture.html.in docs: remove mention of legacy Xen driver 2018-04-09 11:38:47 -06:00
auditlog.html.in docs: fixing typos 'libivrt' > 'libvirt' 2020-01-17 16:44:31 +01:00
auth.html.in docs/auth.html.in: fixed typos 2019-12-23 10:08:05 +00:00
best-practices.rst docs: point users to gitlab for issue tracking 2020-04-09 16:31:17 +01:00
bindings.html.in docs: point to GitLab as the primary git hosting 2020-06-03 13:38:33 +02:00
browserconfig.xml docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
bugs.html.in docs: point users to gitlab for issue tracking 2020-04-09 16:31:17 +01:00
cgroups.html.in doc: cgroups: Remove unwanted references to systemd 2019-11-15 15:45:20 +01:00
ci.rst docs: Remove libvirt-dockerfiles from CI dashboard 2020-06-15 14:40:24 +02:00
coding-style.rst docs: Use definition list instead of table in coding style 2020-05-11 13:55:25 +02:00
committer-guidelines.rst docs: Add committer-guidelines.rst 2020-04-08 09:32:36 +02:00
compiling.html.in gnulib: delete all gnulib integration 2020-02-07 15:03:54 +00:00
contact.html.in docs: switch to using HTML5 doctype declaration 2017-08-02 17:00:11 +01:00
contribute.html.in po: update docs to refer to Weblate instead of Zanata 2020-06-08 16:38:47 +01:00
csharp.html.in docs: point to GitLab as the primary git hosting 2020-06-03 13:38:33 +02:00
daemons.rst docs: fix mistaken description of the read-only socket units 2020-04-16 16:26:13 +01:00
dbus.html.in docs: point to GitLab as the primary git hosting 2020-06-03 13:38:33 +02:00
developer-tooling.rst docs: Add developer-tooling.rst 2020-04-08 09:32:35 +02:00
devguide.html.in docs: update all GIT repo examples to use https:// protocol 2018-03-21 14:48:01 +00:00
docs.html.in docs: introduce a page showing a overall CI dashboard 2020-05-11 12:35:03 +01:00
downloads.html.in docs: Update after libvirt-ruby repository rename 2020-05-15 16:18:18 +02:00
drivers.html.in secrets: add support for running secret driver in embedded mode 2020-01-27 11:04:29 +00:00
drvbhyve.html.in docs: bhyve: warn about bhyve:commandline risks 2019-02-01 22:08:55 +04:00
drvesx.html.in docs: mention lifted vCPUs restriction for esx 2019-11-14 14:55:56 +01:00
drvhyperv.html.in docs: switch to using HTML5 doctype declaration 2017-08-02 17:00:11 +01:00
drvlxc.html.in docs: Grammar and spelling fixes 2018-05-03 12:40:37 +01:00
drvnodedev.html.in docs: Document full node device xml in formatnode.html.in 2020-05-22 12:28:59 +02:00
drvopenvz.html.in docs: switch to using HTML5 doctype declaration 2017-08-02 17:00:11 +01:00
drvqemu.html.in qemu: do not allow /dev/rtc or /dev/hpet access via the devices cgroup 2020-05-19 10:04:06 +02:00
drvremote.html.in docs: switch to using HTML5 doctype declaration 2017-08-02 17:00:11 +01:00
drvsecret.html.in docs: fix since version in driver documentation 2020-01-27 17:36:05 +01:00
drvtest.html.in docs: switch to using HTML5 doctype declaration 2017-08-02 17:00:11 +01:00
drvvbox.html.in docs: Update vbox driver documentation. 2017-11-07 17:50:15 -05:00
drvvirtuozzo.html.in docs: switch to using HTML5 doctype declaration 2017-08-02 17:00:11 +01:00
drvvmware.html.in docs: switch to using HTML5 doctype declaration 2017-08-02 17:00:11 +01:00
drvxen.html.in libxl: Drop support for parsing sxpr format in libxlConnectDomainXMLFromNative 2019-07-09 10:27:19 +02:00
errors.html.in docs: Grammar and spelling fixes 2018-05-03 12:40:37 +01:00
favicon-16x16.png docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
favicon-32x32.png docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
favicon.ico docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
firewall.html.in network: allow configuring firewalld zone for virtual network bridge device 2019-02-01 12:57:13 -05:00
format.html.in backup: Document new XML for backups 2019-12-10 12:41:56 +01:00
formatbackup.html.in backup: Allow 'encryption' of backups and scratch images 2020-04-14 18:49:41 +02:00
formatcaps.html.in conf: add support for specifying CPU "dies" parameter 2020-01-16 15:11:42 +00:00
formatcheckpoint.html.in backup: Document new XML for backups 2019-12-10 12:41:56 +01:00
formatdomain.html.in formatdomain.html.in: document the NUMA cpus auto fill feature 2020-06-18 12:31:54 +02:00
formatdomaincaps.html.in conf: Advertise migratable attribute for CPU in domcaps 2020-06-09 20:32:50 +02:00
formatnetwork.html.in conf: add an attribute to turn on NAT for IPv6 virtual networks 2020-06-15 17:10:15 +01:00
formatnetworkport.html.in docs: document port isolated property in domain/network/networkport 2020-02-26 11:48:23 -05:00
formatnode.html.in docs: note node device fields that are read-only 2020-06-19 10:39:55 +02:00
formatnwfilter.html.in Drop UML driver 2018-12-17 17:52:46 +01:00
formatsecret.html.in docs: secret: Unify and sanitize examples on how to set secret value 2020-01-28 18:10:36 +01:00
formatsnapshot.html.in backup: Prevent snapshots and checkpoints at same time 2019-07-29 08:22:29 -05:00
formatstorage.html.in storage: optional 'refresh' elemement on pool 2019-03-19 16:46:21 +01:00
formatstoragecaps.html.in caps: drop requiredSourceElements from storage pool capabilities 2019-03-07 12:01:09 +01:00
formatstorageencryption.html.in storage: Disallow create/resize of qcow2 encrypted images 2018-06-26 14:02:43 -04:00
generic.css docs: add styling for <tt> element 2019-12-04 15:48:28 +00:00
goals.html.in docs: switch to using HTML5 doctype declaration 2017-08-02 17:00:11 +01:00
governance.html.in docs/governance: Clarify the version number of the LGPL 2019-01-25 14:04:20 +01:00
hacking.rst po: update docs to refer to Weblate instead of Zanata 2020-06-08 16:38:47 +01:00
hooks.html.in network: convert hook script to take a network port XML 2019-06-17 15:19:54 +01:00
index.html.in backup: Document new XML for backups 2019-12-10 12:41:56 +01:00
internals.html.in docs: switch to using HTML5 doctype declaration 2017-08-02 17:00:11 +01:00
java.html.in docs: point to GitLab as the primary git hosting 2020-06-03 13:38:33 +02:00
kbase.html.in docs: Describe protected virtualization guest setup 2020-06-16 09:43:45 +02:00
libvirt-daemon-arch.fig
libvirt-daemon-arch.png
libvirt-driver-arch.fig
libvirt-driver-arch.png
libvirt-go-xml.rst docs: add pages to support Go module package resolution 2020-01-27 11:51:46 +00:00
libvirt-go.rst docs: add pages to support Go module package resolution 2020-01-27 11:51:46 +00:00
libvirt-object-model.fig
libvirt-object-model.png
libvirt-virConnect-example.fig
libvirt-virConnect-example.png
libvirt.css news: Convert to reStructuredText 2020-06-05 16:27:33 +02:00
logging.html.in logging.html.in: fix number of output formats available 2020-05-20 10:36:17 +02:00
main.css docs: make website responsive for mobile devices 2017-08-07 14:44:40 +01:00
Makefile.am news: Convert to reStructuredText 2020-06-05 16:27:33 +02:00
manifest.json docs: Fix syntax-check error 2017-08-02 15:00:28 -04:00
migration-managed-direct.fig
migration-managed-direct.png
migration-managed-p2p.fig
migration-managed-p2p.png
migration-native.fig
migration-native.png
migration-tunnel.fig
migration-tunnel.png
migration-unmanaged-direct.fig
migration-unmanaged-direct.png
migration.html.in docs: relax CSS context match for pretty tables 2019-12-04 15:48:28 +00:00
mobile.css docs: add advanced search capabilities 2019-04-11 15:20:17 +01:00
mstile-150x150.png docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
newapi.xsl docs: relax CSS context match for pretty tables 2019-12-04 15:48:28 +00:00
newreposetup.rst docs: Document CIRRUS_GITHUB_REPO variable 2020-06-11 12:03:41 +02:00
node.fig
node.gif
nss.html.in docs: switch to using HTML5 doctype declaration 2017-08-02 17:00:11 +01:00
page.xsl docs: add 'edit this page' link to footer of every page 2020-04-09 12:01:49 +01:00
pci-addresses.rst docs: Document reserved PCI addresses for QEMU 2020-04-24 09:55:29 +02:00
pci-hotplug.html.in docs: Advertise pcie-to-pci-bridge for use on q35 2019-06-20 10:03:22 +02:00
php.html.in docs: point to GitLab as the primary git hosting 2020-06-03 13:38:33 +02:00
platforms.html.in docs: expand macOS platform support coverage 2020-01-03 15:42:12 +00:00
programming-languages.rst docs: Add programming-languages.rst 2020-04-08 09:32:32 +02:00
python.html.in doc/python: Update to Python 3 2020-04-20 14:06:25 +01:00
remote.html.in docs: move docs about remote driver URIs into URI docs 2019-12-04 15:48:28 +00:00
securityprocess.html.in docs: point to GitLab as the primary git hosting 2020-06-03 13:38:33 +02:00
site.xsl docs: add 'edit this page' link to footer of every page 2020-04-09 12:01:49 +01:00
storage.html.in storage: add vmfs filesystem type 2019-12-20 14:31:08 +01:00
strategy.html.in docs: attempt to document the general libvirt dev strategy 2019-10-01 13:08:01 +01:00
structures.fig
styleguide.rst docs: Document list-tables as recommended 2020-05-11 13:55:27 +02:00
submitting-patches.rst docs: Add submitting-patches.rst 2020-04-08 09:32:42 +02:00
subsite.xsl docs: add 'edit this page' link to footer of every page 2020-04-09 12:01:49 +01:00
support.html.in docs: Grammar and spelling fixes 2018-05-03 12:40:37 +01:00
testapi.html.in docs: point to GitLab as the primary git hosting 2020-06-03 13:38:33 +02:00
testsuites.html.in docs: point to GitLab as the primary git hosting 2020-06-03 13:38:33 +02:00
testtck.html.in docs: point to GitLab as the primary git hosting 2020-06-03 13:38:33 +02:00
tlscerts.html.in docs: split TLS certificate setup into its own file 2019-12-04 15:48:28 +00:00
uri.html.in docs: move docs about remote driver URIs into URI docs 2019-12-04 15:48:28 +00:00
virshcmdref.html.in docs: virshcmdref: change repo URL to GitLab 2020-06-03 13:38:33 +02:00
windows.html.in build: mandate use of a build dir != src dir 2019-11-08 17:07:35 +01:00
wrapstring.xsl