External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-11-03 20:01:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
c203b8fee1
libvirt/docs/docs.html.in

188 lines
7.4 KiB
HTML
Raw Normal View History

Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
<?xml version="1.0" encoding="UTF-8"?>
docs: switch to using HTML5 doctype declaration The HTML5 doctype is simply <!DOCTYPE html> no DTD is present because HTML5 is no longer defined as an extension of SGML. XSL has no way to natively output a doctype without a public or system identifier, so we have to use an <xsl:text> hack instead. See also https://dev.w3.org/html5/html-author/#doctype-declaration Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 17:01:25 +00:00
<!DOCTYPE html>
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
<html xmlns="http://www.w3.org/1999/xhtml">
docs: remove navigation sidebar from pages A combination of the index page, top nav bar and docs.html page provide links to all pages on the site. The left hand nav bar is thus redundant and can be removed to provide a simpler style for the site. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:25:26 +00:00
<body class="docs">
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<div class="panel">
<h2>Deployment / operation</h2>
<dl>
<dt><a href="apps.html">Applications</a></dt>
<dd>Applications known to use libvirt</dd>
docs: introduce rst2man as a mandatory tool for building docs The rst2man tool is provided by python docutils, and as the name suggests, it converts RST documents into man pages. The intention is that our current POD docs will be converted to RST format, allowing one more use of Perl to be eliminated from libvirt. The manual pages will now all be kept in the docs/manpages/ directory, which enables us to include the man pages in the published website. This is good for people searching for libvirt man pages online as it makes it more likely google will send them to the libvirt.org instead of some random third party man page site with outdated content. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 13:18:36 +00:00
<dt><a href="manpages/index.html">Manual pages</a></dt>
<dd>Manual pages for libvirt tools / daemons</dd>
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<dt><a href="windows.html">Windows</a></dt>
<dd>Downloads for Windows</dd>
<dt><a href="migration.html">Migration</a></dt>
<dd>Migrating guests between machines</dd>
docs: add page describing the libvirt daemons Now that we have more than just the libvirtd daemon, we should be explaining to users what they are all for & important aspects of their configuration. Reviewed-by: Erik Skultety <eskultet@redhat.com> Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-14 09:54:22 +00:00
<dt><a href="daemons.html">Daemons</a></dt>
<dd>Overview of the daemons provided by libvirt</dd>
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<dt><a href="remote.html">Remote access</a></dt>
<dd>Enable remote access over TCP</dd>
docs: split TLS certificate setup into its own file The generation and deployment of x509 certificates for TLS is complex and verbose and thus deserves its own standalone page. Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-08 16:08:24 +00:00
<dt><a href="tlscerts.html">TLS certs</a></dt>
<dd>Generate and deploy x509 certificates for TLS</dd>
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<dt><a href="auth.html">Authentication</a></dt>
<dd>Configure authentication for the libvirt daemon</dd>
<dt><a href="acl.html">Access control</a></dt>
<dd>Configure access control libvirt APIs with <a href="aclpolkit.html">polkit</a></dd>
<dt><a href="logging.html">Logging</a></dt>
<dd>The library and the daemon logging support</dd>
<dt><a href="auditlog.html">Audit log</a></dt>
<dd>Audit trail logs for host operations</dd>
<dt><a href="firewall.html">Firewall</a></dt>
<dd>Firewall and network filter configuration</dd>
<dt><a href="hooks.html">Hooks</a></dt>
<dd>Hooks for system specific management</dd>
<dt><a href="nss.html">NSS module</a></dt>
<dd>Enable domain host name translation to IP addresses</dd>
<dt><a href="http://wiki.libvirt.org/page/FAQ">FAQ</a></dt>
<dd>Frequently asked questions</dd>
</dl>
</div>
<div class="panel">
<h2>Application development</h2>
<dl>
docs: remove link to virsh cmd ref & app dev guide Both the application developer guide and virsh command reference are unmaintained for best part of 8 years, and so horrifically out of date. This does not give a good impression to people reading the docs. Now that we are publishing the man pages online, those are a better doc to read for virsh. We can also highlight the API reference instead of the app dev guide. The virsh command reference & app dev guide will still exist on the web root, but will not be linked to. Reviewed-by: Ján Tomko <jtomko@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-12-13 10:04:18 +00:00
<dt><a href="html/index.html">API reference</a></dt>
<dd>Reference manual for the C public API, split in
<a href="html/libvirt-libvirt-common.html">common</a>,
<a href="html/libvirt-libvirt-domain.html">domain</a>,
<a href="html/libvirt-libvirt-domain-checkpoint.html">domain checkpoint</a>,
<a href="html/libvirt-libvirt-domain-snapshot.html">domain snapshot</a>,
<a href="html/libvirt-virterror.html">error</a>,
<a href="html/libvirt-libvirt-event.html">event</a>,
<a href="html/libvirt-libvirt-host.html">host</a>,
<a href="html/libvirt-libvirt-interface.html">interface</a>,
<a href="html/libvirt-libvirt-network.html">network</a>,
<a href="html/libvirt-libvirt-nodedev.html">node device</a>,
<a href="html/libvirt-libvirt-nwfilter.html">network filter</a>,
<a href="html/libvirt-libvirt-secret.html">secret</a>,
<a href="html/libvirt-libvirt-storage.html">storage</a>,
<a href="html/libvirt-libvirt-stream.html">stream</a>
and
<a href="html/index-admin.html">admin</a>,
<a href="html/index-qemu.html">QEMU</a>,
<a href="html/index-lxc.html">LXC</a> libs
</dd>
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
docs: introduce libvirt-dbus binding libvirt-dbus is a new binding that wraps libvirt API into D-Bus calls. Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
2017-07-04 14:50:00 +00:00
<dt><a href="bindings.html">Language bindings and API modules</a></dt>
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<dd>Bindings of the libvirt API for
<a href="csharp.html">c#</a>,
Point to the new libvirt-go bindings The github.com/rgbkrk/libvirt-go bindings were the most complete bindings historically, but their API coverage stops at 1.2.4, with exception of a couple of newer APIs. The new bindings at http://libvirt.org/git/?p=libvirt-go.git;a=log how have (almost[1]) 100% API coverage all the way to 2.5.0. They also expose the APIs in a way that allows for much stronger go type checking by the compiler, and expose typed parameters as explicit structs. Finally the bindings are able to conditionally compile against any libvirt version 1.2.0 -> 2.5.0 without use of go build tags. Change the docs to point to these new bindings, since they'll be a better bet for users long term. [1] virEvent & virStream callbacks are still TODO to be fixed real soon. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-12-13 17:05:16 +00:00
<a href="https://godoc.org/github.com/libvirt/libvirt-go">go</a>,
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<a href="java.html">java</a>,
docs: fix a typo in docs.html page Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
2018-03-23 11:52:13 +00:00
<a href="https://libvirt.org/ocaml/">ocaml</a>,
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<a href="http://search.cpan.org/dist/Sys-Virt/">perl</a>,
<a href="python.html">python</a>,
<a href="php.html">php</a>,
docs: introduce libvirt-dbus binding libvirt-dbus is a new binding that wraps libvirt API into D-Bus calls. Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
2017-07-04 14:50:00 +00:00
<a href="https://libvirt.org/ruby/">ruby</a>
and integration API modules for
<a href="dbus.html">D-Bus</a></dd>
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<dt><a href="format.html">XML schemas</a></dt>
<dd>Description of the XML schemas for
<a href="formatdomain.html">domains</a>,
<a href="formatnetwork.html">networks</a>,
conf: introduce virNetworkPortDefPtr struct and XML support Introduce a virNetworkPortDefPtr struct to represent the data associated with a virtual network port. Add APIs for parsing/formatting XML docs with the data. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2018-08-31 14:21:34 +00:00
<a href="formatnetworkport.html">network ports</a>,
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<a href="formatnwfilter.html">network filtering</a>,
<a href="formatstorage.html">storage</a>,
<a href="formatstorageencryption.html">storage encryption</a>,
<a href="formatcaps.html">capabilities</a>,
<a href="formatdomaincaps.html">domain capabilities</a>,
docs: Add description for Storage Pool Capabilities Signed-off-by: John Ferlan <jferlan@redhat.com> ACKed-by: Michal Privoznik <mprivozn@redhat.com>
2019-02-07 20:26:00 +00:00
<a href="formatstoragecaps.html">storage pool capabilities</a>,
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<a href="formatnode.html">node devices</a>,
<a href="formatsecret.html">secrets</a>,
backup: Document new XML for checkpoints Prepare for new checkpoint APIs by describing the XML that will represent a checkpoint. The checkpoint XML is modeled heavily after virDomainSnapshotPtr. See the docs for more details. Add testsuite coverage for some minimal uses of the XML (bare minimum, the sample from html, and a full dumpxml, and some counter-examples that should fail schema validation). Although use of the REDEFINE flag will require the <domain> subelement to be present, it is easier for most of the tests to provide counterpart output produced with the NO_DOMAIN flag (particularly since synthesizing a valid <domain> during testing is not trivial). Signed-off-by: Eric Blake <eblake@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2018-06-12 03:12:21 +00:00
<a href="formatsnapshot.html">snapshots</a>,
backup: Document new XML for backups Prepare for new backup APIs by describing the XML that will represent a backup. The XML resembles snapshots and checkpoints in being able to select actions for a set of disks, but has other differences. It can support both push model (the hypervisor does the backup directly into the destination file) and pull model (the hypervisor exposes an access port for a third party to grab what is necessary). Add testsuite coverage for some minimal uses of the XML. The <disk> element within <domainbackup> tries to model the same elements as a <disk> under <domain>, but sharing the RNG grammar proved to be hairy. That is in part because while <domain> use <source> to describe a host resource in use by the guest, a backup job is using a host resource that is not visible to the guest: a push backup action is instead describing a <target> (which ultimately could be a remote network resource, but for simplicity the RNG just validates a local file for now), and a pull backup action is instead describing a temporary local file <scratch> (which probably should not be a remote resource). A future refactoring may thus introduce some way to parameterize RNG to accept <disk type='FOO'>...</disk> so that the name of the subelement can be <source> for domain, or <target> or <scratch> as needed for backups. Future patches may improve this area of code. Signed-off-by: Eric Blake <eblake@redhat.com> Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2019-08-22 01:42:41 +00:00
<a href="formatcheckpoint.html">checkpoints</a>,
<a href="formatbackup.html">backup jobs</a></dd>
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<dt><a href="uri.html">URI format</a></dt>
<dd>The URI formats used for connecting to libvirt</dd>
<dt><a href="cgroups.html">CGroups</a></dt>
<dd>Control groups integration</dd>
<dt><a href="drivers.html">Drivers</a></dt>
<dd>Hypervisor specific driver information</dd>
docs: add a page describing support guarantees for libvirt features While we have collective knowledge about the support status of various parts of libvirt, this has never been formally documented, leaving our users to guess. Note, this document makes one change to our previous policy. It explicitly declares the RPC protocol of libvirtd as being a supported interface. THis accepts the reality that we can a) never change it without breaking compat with old libvirt.so, b) there are both rust + go impls that are written against the RPC protocol already. Reviewed-by: John Ferlan <jferlan@redhat.com> Reviewed-by: Jim Fehlig <jfehlig@suse.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-11-16 17:11:55 +00:00
<dt><a href="support.html">Support guarantees</a></dt>
<dd>Details of support status for various interfaces</dd>
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<dt><a href="hvsupport.html">Driver support</a></dt>
<dd>matrix of API support per hypervisor per release</dd>
docs: introduce a "knowledge base" for task oriented guides The previously added AMD SEV doc was not linked from anywhere on the website. Address this by introducing a new "Knowledge base" section that can hold task oriented guide to various features. Moving the SEV, disk locking and secure usage guides under this section. Reviewed-by: Eric Blake <eblake@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-07-08 12:58:56 +00:00
<dt><a href="kbase.html">Knowledge Base</a></dt>
<dd>Task oriented guides to key features</dd>
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
</dl>
</div>
<div class="panel">
<h2>Project development</h2>
<dl>
<dt><a href="hacking.html">Contributor guidelines</a></dt>
<dd>General hacking guidelines for contributors</dd>
docs: add a minimal style guide for writing RST docs Most importantly we document the required heading markup so that we get consistency across the docs. Also mention that docs should have a table of contents if they have headings & are likely longer than one page of text. The 3-space indent rule may sound wierd, but that's what python has recommended and thus what tools like pandoc emit. Rather than try to reindent things to 4-space, just accept this RST norm. Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-11-18 18:37:09 +00:00
<dt><a href="styleguide.html">Docs style guide</a></dt>
<dd>Style guidelines for reStructuredText docs</dd>
docs: attempt to document the general libvirt dev strategy There are various ideas / plans floating around for future libvirt work, some of which is actively in progress. Historically we've never captured this kind of information anywhere, except in mailing list discussions. In particular guidelines in hacking.html.in don't appear until a policy is actively applied. This patch attempts to fill the documentation gap, by creating a new "strategy" page which outlines the general vision for some notable future changes. The key thing to note is that none of the stuff on this page is guaranteed, plans may change as new information arises. IOW this is a "best guess" as to the desired future. This doc has focused on three areas, related to the topic of language usage / consolidation - Use of non-C languages for the library, daemons or helper tools - Replacement of autotools with meson - Use of RST and Sphinx for documentation (website + man pages) Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-09-19 11:48:15 +00:00
<dt><a href="strategy.html">Project strategy</a></dt>
<dd>Sets a vision for future direction &amp; technical choices</dd>
docs: introduce a page showing a overall CI dashboard With the move to GitLab CI one of the things we miss from Jenkins is a single page dashboard showing CI status across all projects. This is a very simple replacement that uses badges for CI pipeline status. A CSS tweak is needed because RST->HTML adds redundant <p> tags inside table cells which causes excessive vertical whitespace to appear. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-05-04 12:15:43 +00:00
<dt><a href="ci.html">CI Testing</a></dt>
<dd>Details of the Continuous Integration testing strategy</dd>
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
<dt><a href="bugs.html">Bug reports</a></dt>
<dd>How and where to report bugs and request features</dd>
<dt><a href="compiling.html">Compiling</a></dt>
<dd>How to compile libvirt</dd>
<dt><a href="goals.html">Goals</a></dt>
<dd>Terminology and goals of libvirt API</dd>
<dt><a href="api.html">API concepts</a></dt>
<dd>The libvirt API concepts</dd>
<dt><a href="api_extension.html">API extensions</a></dt>
<dd>Adding new public libvirt APIs</dd>
<dt><a href="internals/eventloop.html">Event loop and worker pool</a></dt>
<dd>Libvirt's event loop and worker pool mode</dd>
<dt><a href="internals/command.html">Spawning commands</a></dt>
<dd>Spawning commands from libvirt driver code</dd>
<dt><a href="internals/rpc.html">RPC protocol &amp; APIs</a></dt>
<dd>RPC protocol information and API / dispatch guide</dd>
<dt><a href="internals/locking.html">Lock managers</a></dt>
<dd>Use lock managers to protect disk content</dd>
<dt><a href="testsuites.html">Functional testing</a></dt>
<dd>Testing libvirt with <a href="testtck.html">TCK test suite</a> and
<a href="testapi.html">Libvirt-test-API</a></dd>
docs: list settings required in creating a new git repo The libvirt project has alot of git repositories, and they must all be configured in the same way, more or less. This page documents the settings changes that I have made in GitLab and GitHub when configuring projects, both as a reminder for myself, and to help anyone else doing the same in future. Also included is info about the repo mirroring on the libvirt.org server. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-08 16:36:05 +00:00
<dt><a href="newreposetup.html">New repo setup</a></dt>
<dd>Procedure for configuring new git repositories for libvirt</dd>
docs: fill out docs page with useful links The docs page is currently completely empty. Fill it in with links to the various documentation, categorized as to whether it is targetting people deploying libvirt, application developers using libvirt, or people working on libvirt itself. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-31 11:29:21 +00:00
</dl>
</div>
<br class="clear"/>
Split website out into one file per page. APply new layout and styling
2008-04-23 17:08:31 +00:00
</body>
</html>
Reference in New Issue Copy Permalink