External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-03-20 07:59:00 +00:00
Code
libvirt/docs
History
Erik Skultety 39a80474f6 docs: html.in: Convert api to rst 
There were a number of occurrences where we used nested inline markup
(verbatim + refs) which is currently not possible with RST syntax [1].
There is a possible workaround involving substitution definitions like

  .. |virConnectPtr| replace:: ``virConnectPtr``
  .. _virConnectPtr: /html/libvirt-libvirt-host.html#virConnectPtr

Substitutions cannot be made generic, hence we cannot create a template
for substitution and use a single template everywhere, so we'd end up
with a lot of clutter and convolution. Therefore, we can make an
exception and just link the data type without further style markup.

[1] https://docutils.sourceforge.io/FAQ.html#is-nested-inline-markup-possible

Signed-off-by: Erik Skultety <eskultet@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
2021-03-15 17:31:35 +01:00
..
fonts
meson: add rule to build and install only web documentation
2020-08-03 09:27:06 +02:00
gitdm
gitdm: add more individual contributors
2020-09-25 16:00:06 +02:00
html
meson: add rule to build and install only web documentation
2020-08-03 09:27:06 +02:00
internals
virBuildPath: Remove return value
2021-03-02 09:50:19 +01:00
js
meson: add rule to build and install only web documentation
2020-08-03 09:27:06 +02:00
kbase
docs: link to PCI docs from the kbase page
2021-01-28 12:13:44 +00:00
logos
docs: fix misc spelling errors reported by codespell
2020-10-05 10:28:37 +01:00
manpages
docs: Document libxl.conf location
2021-03-12 10:52:51 +01:00
schemas
Add 'interleave' to the sub-element for video device in rng file
2021-03-11 17:03:52 +01:00
404.html.in
Use https:// links for most sites
2017-10-16 10:22:34 +01:00
acl.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
aclpolkit.rst
docs: html.in: Convert aclpolkit to rst
2021-03-15 17:31:35 +01:00
advanced-tests.rst
tests: Don't advertise VIR_TEST_EXPENSIVE to users
2020-09-23 11:30:05 +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.rst
docs: html.in: Convert api_extension to rst
2021-03-15 17:31:35 +01:00
api.rst
docs: html.in: Convert api to rst
2021-03-15 17:31:35 +01: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: Mention KubeVirt in apps using Libvirt
2021-01-11 16:06:17 +01:00
architecture.gif
…
architecture.html.in
docs: remove mention of legacy Xen driver
2018-04-09 11:38:47 -06:00
architecture.svg
docs: convert FIG files into SVG format
2020-07-10 16:07:02 +02:00
auditlog.html.in
docs: fixing typos 'libivrt' > 'libvirt'
2020-01-17 16:44:31 +01:00
auth.html.in
docs: fix misc spelling errors reported by codespell
2020-10-05 10:28:37 +01:00
best-practices.rst
Prefer https: for Red Hat websites
2020-09-01 21:58:46 +02:00
bindings.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +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
Prefer https: for Red Hat websites
2020-09-01 21:58:46 +02:00
cgroups.html.in
vircgroup: introduce nested cgroup to properly work with systemd
2021-02-10 13:37:12 +01:00
ci.rst
docs: Update CI documentation
2020-07-03 11:00:51 +02:00
coding-style.rst
util: virstring: Remove virStrncpy
2021-03-12 10:57:42 +01:00
committer-guidelines.rst
meson: adjust our documentation to mention meson instead of autoconf
2020-08-03 09:27:09 +02:00
compiling.html.in
docs: compiling: mention build dir
2021-01-29 16:00:56 +01:00
contact.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
contribute.html.in
Fix errors in contribute.html.in
2020-09-10 09:13:52 +02:00
csharp.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
daemons.rst
docs: fix misc spelling errors reported by codespell
2020-10-05 10:28:37 +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: xsl: Unify stylability of main container element
2020-11-16 14:04:04 +01:00
downloads.html.in
docs: downloads: Establish handover of package signing
2021-01-11 12:04:45 +01: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: document virtio-9p support
2020-10-12 15:26:00 +04:00
drvesx.html.in
docs: fix misc spelling errors reported by codespell
2020-10-05 10:28:37 +01:00
drvhyperv.html.in
docs: drop support for Windows versions prior to 2012R2
2020-11-09 15:26:02 +00:00
drvlxc.html.in
docs: Document lxc.conf location
2021-03-12 10:52:41 +01:00
drvnodedev.html.in
node_device: detecting mdev_types capability on CSS devices
2020-11-11 16:56:33 +01:00
drvopenvz.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
drvqemu.html.in
virConnectOpen: Require root dir to be absolute path
2021-03-12 15:40:13 +01: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
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
drvvirtuozzo.html.in
docs: switch to using HTML5 doctype declaration
2017-08-02 17:00:11 +01:00
drvvmware.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
drvxen.html.in
docs: Document libxl.conf location
2021-03-12 10:52:51 +01: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
doc: document new filters and not documented ones
2020-11-04 17:21:45 +01:00
format.html.in
docs: fix misc spelling errors reported by codespell
2020-10-05 10:28:37 +01:00
formatbackup.rst
conf: backup: Format index of 'store'
2020-12-08 15:12:34 +01:00
formatcaps.html.in
conf: add support for specifying CPU "dies" parameter
2020-01-16 15:11:42 +00:00
formatcheckpoint.rst
conf: checkpoint: Don't require <domain> when redefining checkpoints
2020-12-04 16:15:03 +01:00
formatdomain.rst
conf: add support for audio backend specific settings
2021-03-09 22:58:49 +00:00
formatdomaincaps.html.in
conf: add reporting of "maximum" CPU mode in domain caps
2021-02-10 11:44:48 +00:00
formatnetwork.html.in
Fix format network dns doc
2021-01-26 14:29:48 +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: Clarify the documentation of the <css> elements
2021-02-01 16:02:39 +01:00
formatnwfilter.html.in
doc: document new filters and not documented ones
2020-11-04 17:21:45 +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
conf: snapshot: Add support for <metadata_cache>
2021-01-08 15:27:00 +01:00
formatstorage.html.in
docs: fix misc spelling errors reported by codespell
2020-10-05 10:28:37 +01:00
formatstoragecaps.html.in
docs: Fix link for virConnectGetStoragePoolCapabilities
2020-12-02 16:15:43 +01:00
formatstorageencryption.html.in
docs: support qcow2 format in luks encryption volume
2021-01-05 13:54:11 +01:00
generic.css
docs: css: Make definition list 'code' entries bold when converted from rst
2020-08-03 18:41:11 +02:00
glib-adoption.rst
docs: glib-adoption: add string arrays and objects
2020-10-02 14:10:44 +02: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
Revert "docs: Drop glib-adoption.rst"
2020-10-02 14:10:40 +02:00
hooks.html.in
docs: fix misc spelling errors reported by codespell
2020-10-05 10:28:37 +01:00
index.html.in
docs: use a relative link to the kbase page
2021-02-03 16:33:18 +00:00
internals.html.in
docs: switch to using HTML5 doctype declaration
2017-08-02 17:00:11 +01:00
java.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
libvirt-daemon-arch.png
…
libvirt-daemon-arch.svg
docs: convert FIG files into SVG format
2020-07-10 16:07:02 +02:00
libvirt-driver-arch.png
…
libvirt-driver-arch.svg
docs: convert FIG files into SVG format
2020-07-10 16:07:02 +02:00
libvirt-go-xml.rst
docs: Point to pkg.go.dev instead of godoc.org
2020-07-07 14:07:33 +02:00
libvirt-go.rst
docs: Point to pkg.go.dev instead of godoc.org
2020-07-07 14:07:33 +02:00
libvirt-object-model.png
…
libvirt-object-model.svg
docs: convert FIG files into SVG format
2020-07-10 16:07:02 +02:00
libvirt-virConnect-example.png
…
libvirt-virConnect-example.svg
docs: convert FIG files into SVG format
2020-07-10 16:07:02 +02:00
libvirt.css
docs: css: Modify appearance of the kbase directory page
2020-11-16 14:04:04 +01:00
logging.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
main.css
docs: make website responsive for mobile devices
2017-08-07 14:44:40 +01:00
manifest.json
docs: Fix syntax-check error
2017-08-02 15:00:28 -04:00
meson.build
docs: html.in: Convert api to rst
2021-03-15 17:31:35 +01:00
migration-managed-direct.png
…
migration-managed-direct.svg
docs: convert FIG files into SVG format
2020-07-10 16:07:02 +02:00
migration-managed-p2p.png
…
migration-managed-p2p.svg
docs: convert FIG files into SVG format
2020-07-10 16:07:02 +02:00
migration-native.png
…
migration-native.svg
docs: convert FIG files into SVG format
2020-07-10 16:07:02 +02:00
migration-tunnel.png
…
migration-tunnel.svg
docs: convert FIG files into SVG format
2020-07-10 16:07:02 +02:00
migration-unmanaged-direct.png
…
migration-unmanaged-direct.svg
docs: convert FIG files into SVG format
2020-07-10 16:07:02 +02:00
migration.html.in
docs: migration: remove xenmigr
2021-01-05 13:40:25 +01: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: fix libvirt go-import metadata in pages and links in 404 page
2020-08-04 17:06:33 +01:00
newreposetup.rst
docs: Document CIRRUS_GITHUB_REPO variable
2020-06-11 12:03:41 +02:00
node.gif
…
node.svg
docs: convert FIG files into SVG format
2020-07-10 16:07:02 +02:00
nss.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
page.xsl
docs: xsl: Unify stylability of main container element
2020-11-16 14:04:04 +01:00
pci-addresses.rst
docs: Document reserved PCI addresses for QEMU
2020-04-24 09:55:29 +02:00
pci-hotplug.html.in
Prefer https: for libguestfs.org links
2020-09-01 21:58:46 +02:00
php.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
platforms.rst
docs: Spell out our policy concerning minor releases
2021-03-04 18:28:44 +01:00
programming-languages.rst
Fix capitalization "CLang" -> "Clang"
2020-11-12 15:01:42 +01:00
python.html.in
doc/python: Update to Python 3
2020-04-20 14:06:25 +01:00
remote.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
securityprocess.html.in
docs: fix misc spelling errors reported by codespell
2020-10-05 10:28:37 +01:00
site.xsl
docs: fix libvirt go-import metadata in pages and links in 404 page
2020-08-04 17:06:33 +01:00
storage.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
strategy.html.in
docs: fix misc spelling errors reported by codespell
2020-10-05 10:28:37 +01:00
structures.svg
docs: convert FIG files into SVG format
2020-07-10 16:07:02 +02:00
styleguide.rst
docs: Document list-tables as recommended
2020-05-11 13:55:27 +02:00
submitting-patches.rst
docs/submitting-patches: add reference to DCO
2020-10-09 09:12:39 +02:00
subsite.xsl
docs: fix libvirt go-import metadata in pages and links in 404 page
2020-08-04 17:06:33 +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
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
testtck.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
tlscerts.html.in
docs: tlscerts: Fix a few broken links
2021-02-16 08:35:09 +01:00
uri.html.in
docs: Add 'known_hosts_verify' parameter for libssh(2) connection uris
2021-02-05 16:02:22 +01:00
virshcmdref.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00
windows.html.in
Prefer https: everywhere where possible
2020-09-01 21:58:46 +02:00