From nobody Mon Feb 9 19:30:40 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1649340065; cv=none; d=zohomail.com; s=zohoarc; b=nCfH1rpoPA4hbpS+aNv8Nf8elRTGjQM+rSN10T4PlzqVnNjqJDPMOc1a+d28BQzPvYRoUSv+jo/MjCXXqSlioRcAxJrK2lDa9jHOlU8zg4mag3Cqvhe3beepRyaGRx6zMrgLKBTXk/UlEKzwupfJqRKc6lWRz11FTw2Ozcf5qsc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1649340065; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=ytEo7YKGWQgHNBQUksS97MIzAxg10lh0D6FenPl8BoE=; b=bJuLM+cN+Rox9iAJ+V6meXwoIPTcsf1KD7bX+SOMzZMT/EwBsIYavQkmYwNZUE6IcqJEwxrX6HAw50s3vegYceoSIEhtvS6HMeNBge8D+eF6QXx2N67DsTc2MbnYflnFa/GsBzVVh55ohWjfWOFSOwckSVM5mhGFYVvB18Mq2O8= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1649340065770214.43453135148184; Thu, 7 Apr 2022 07:01:05 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-590-fe4bAbgcPwKLLUbt_seRNQ-1; Thu, 07 Apr 2022 10:01:01 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id D97C32A2AD59; Thu, 7 Apr 2022 14:00:42 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id BF82740470D5; Thu, 7 Apr 2022 14:00:42 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 838E61949761; Thu, 7 Apr 2022 14:00:42 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 73A46194034B for ; Thu, 7 Apr 2022 14:00:39 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 62974403171; Thu, 7 Apr 2022 14:00:39 +0000 (UTC) Received: from speedmetal.lan (unknown [10.40.208.35]) by smtp.corp.redhat.com (Postfix) with ESMTP id 71AB340314D for ; Thu, 7 Apr 2022 14:00:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1649340064; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=ytEo7YKGWQgHNBQUksS97MIzAxg10lh0D6FenPl8BoE=; b=PeseU15qvgCu0Tt78SDHQk7siM6cvzLG5FSL8NdA1IRjpao2ZES3jxBoeQQntuYLgLLAY6 m3gh5M9zX5Fx4bE05DttWIw2ijm4aM36I/h6XVuN1rAWIeUa2pBUnFAddiYn6C6DDDg8zO A3t59GEBaabYWdZamLENzCIR8ivuo+I= X-MC-Unique: fe4bAbgcPwKLLUbt_seRNQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 04/11] docs: Convert 'docs' index page to rst Date: Thu, 7 Apr 2022 16:00:26 +0200 Message-Id: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.10 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1649340066610100001 Content-Type: text/plain; charset="utf-8"; x-default="true" Along with the conversion we need to adapt the stylesheets to apply to the new document similarly to how we do that in the knowledge base. Note that one visible difference is that now a 'Documentation' heading is visible on top of the page. Signed-off-by: Peter Krempa --- docs/css/libvirt.css | 17 ++-- docs/docs.html.in | 188 ------------------------------------------- docs/docs.rst | 175 ++++++++++++++++++++++++++++++++++++++++ docs/meson.build | 2 +- 4 files changed, 188 insertions(+), 194 deletions(-) delete mode 100644 docs/docs.html.in create mode 100644 docs/docs.rst diff --git a/docs/css/libvirt.css b/docs/css/libvirt.css index b08271ea4d..2ae80f8595 100644 --- a/docs/css/libvirt.css +++ b/docs/css/libvirt.css @@ -105,8 +105,8 @@ } #index.document, -#docs.document, #hvsupport.document, +#documentation.document, #knowledge-base.document { width: inherit; @@ -397,6 +397,7 @@ h6:hover > a.headerlink { } div.panel, +#documentation .section, #knowledge-base .section { width: 24%; @@ -406,6 +407,7 @@ div.panel, } div.panel h2, +#documentation .section h1, #knowledge-base .section h1 { margin-top: 0px; padding: 0.5em; @@ -423,15 +425,12 @@ div.panel h2, height: 300px; } +#documentation.document > h1, #knowledge-base.document > h1 { text-align: center; padding: 1em; } -#docs.document h1 { - visibility: hidden; -} - br.clear { clear: both; border: 0px; @@ -485,11 +484,13 @@ br.clear { } div.panel dd, +#documentation dd, #knowledge-base dd { font-size: smaller; } div.panel a, +#documentation a, #knowledge-base a { text-decoration: none; } @@ -497,6 +498,9 @@ div.panel a, div.panel ul, div.panel p, div.panel dl, +#documentation ul, +#documentation p, +#documentation dl, #knowledge-base ul, #knowledge-base p, #knowledge-base dl { @@ -505,16 +509,19 @@ div.panel dl, } div.panel ul, +#documentation ul, #knowledge-base ul { margin-left: 1em; } div.panel dt, +#documentation dt, #knowledge-base dt { margin: 0px; } div.panel dd, +#documentation dd, #knowledge-base dd { margin: 0px; margin-bottom: 1em; diff --git a/docs/docs.html.in b/docs/docs.html.in deleted file mode 100644 index ff7a95fae7..0000000000 --- a/docs/docs.html.in +++ /dev/null @@ -1,188 +0,0 @@ - - - - -

Documentation

-
-

Deployment / operation

- -
-
Applications
-
Applications known to use libvirt
- -
Manual pages
-
Manual pages for libvirt tools / daemons
- -
Windows
-
Downloads for Windows
- -
macOS
-
Working with libvirt on macOS
- -
Migration
-
Migrating guests between machines
- -
Daemons
-
Overview of the daemons provided by libvirt
- -
Remote access
-
Enable remote access over TCP
- -
Authentication
-
Configure authentication for the libvirt daemon
- -
Access control
-
Configure access control libvirt APIs with polkit
- -
Logging
-
The library and the daemon logging support
- -
Audit log
-
Audit trail logs for host operations
- -
Firewall
-
Firewall and network filter configuration
- -
Hooks
-
Hooks for system specific management
- -
NSS module
-
Enable domain host name translation to IP addresses
- -
FAQ
-
Frequently asked questions
-
- -
- -
-

Application development

-
-
API reference
-
Reference manual for the C public API, split in - common, - domain, - domain c= heckpoint, - domain sna= pshot, - error, - event, - host, - interface, - network, - node device, - network filter, - secret, - storage, - stream - and - admin, - QEMU, - LXC libs -
- -
Language bindings and API modules
-
Bindings of the libvirt API for - c#, - go, - java, - ocaml, - perl, - python, - php, - ruby - and integration API modules for - D-Bus
- - -
XML schemas
-
Description of the XML schemas for - domains, - networks, - network ports, - network filtering, - storage, - storage encryption, - capabilities, - domain capabilities, - storage pool capabilities, - node devices, - secrets, - snapshots, - checkpoints, - backup jobs
- -
URI format
-
The URI formats used for connecting to libvirt
- -
CGroups
-
Control groups integration
- -
Drivers
-
Hypervisor specific driver information
- -
Support guarantees
-
Details of support status for various interfaces
- -
Driver support
-
matrix of API support per hypervisor per release
- -
Knowledge Base
-
Task oriented guides to key features
-
-
- -
-

Project development

-
-
Contributor guidelines
-
General hacking guidelines for contributors
- -
Docs style guide
-
Style guidelines for reStructuredText docs
- -
Project strategy
-
Sets a vision for future direction & technical choices
- -
CI Testing
-
Details of the Continuous Integration testing strategy
- -
Bug reports
-
How and where to report bugs and request features
- -
Compiling
-
How to compile libvirt
- -
Goals
-
Terminology and goals of libvirt API
- -
API concepts
-
The libvirt API concepts
- -
API extensions
-
Adding new public libvirt APIs
- -
Event loop and worker poo= l
-
Libvirt's event loop and worker pool mode
- -
Spawning commands
-
Spawning commands from libvirt driver code
- -
RPC protocol & APIs
-
RPC protocol information and API / dispatch guide
- -
Lock managers
-
Use lock managers to protect disk content
- -
Functional testing
-
Testing libvirt with TCK test suite and - Libvirt-test-API
- -
New repo setup
-
Procedure for configuring new git repositories for libvirt
-
-
- -
- - - diff --git a/docs/docs.rst b/docs/docs.rst new file mode 100644 index 0000000000..299c26d09b --- /dev/null +++ b/docs/docs.rst @@ -0,0 +1,175 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Documentation +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Deployment / operation +---------------------- + +`Applications `__ + Applications known to use libvirt + +`Manual pages `__ + Manual pages for libvirt tools / daemons + +`Windows `__ + Downloads for Windows + +`macOS `__ + Working with libvirt on macOS + +`Migration `__ + Migrating guests between machines + +`Daemons `__ + Overview of the daemons provided by libvirt + +`Remote access `__ + Enable remote access over TCP + +`TLS certs `__ + Generate and deploy x509 certificates for TLS + +`Authentication `__ + Configure authentication for the libvirt daemon + +`Access control `__ + Configure access control libvirt APIs with `polkit `__ + +`Logging `__ + The library and the daemon logging support + +`Audit log `__ + Audit trail logs for host operations + +`Firewall `__ + Firewall and network filter configuration + +`Hooks `__ + Hooks for system specific management + +`NSS module `__ + Enable domain host name translation to IP addresses + +`FAQ `__ + Frequently asked questions + +Application development +----------------------- + +`API reference `__ + Reference manual for the C public API, split in + `common `__, + `domain `__, + `domain checkpoint `__, + `domain snapshot `__, + `error `__, + `event `__, + `host `__, + `interface `__, + `network `__, + `node device `__, + `network filter `__, + `secret `__, + `storage `__, + `stream `__ and + `admin `__, + `QEMU `__, + `LXC `__ libs + +`Language bindings and API modules `__ + Bindings of the libvirt API for + `c# `__, + `go `__, + `java `__, + `ocaml `__, + `perl `__, + `python `__, + `php `__, + `ruby `__ + and integration API modules for + `D-Bus `__ + +`XML schemas `__ + Description of the XML schemas for + `domains `__, + `networks `__, + `network ports `__, + `network filtering `__, + `storage `__, + `storage encryption `__, + `capabilities `__, + `domain capabilities `__, + `storage pool capabilities `__, + `node devices `__, + `secrets `__, + `snapshots `__, + `checkpoints `__, + `backup jobs `__ + +`URI format `__ + The URI formats used for connecting to libvirt + +`CGroups `__ + Control groups integration + +`Drivers `__ + Hypervisor specific driver information + +`Support guarantees `__ + Details of support status for various interfaces + +`Driver support `__ + matrix of API support per hypervisor per release + +`Knowledge Base `__ + Task oriented guides to key features + +Project development +------------------- + +`Contributor guidelines `__ + General hacking guidelines for contributors + +`Docs style guide `__ + Style guidelines for reStructuredText docs + +`Project strategy `__ + Sets a vision for future direction & technical choices + +`CI Testing `__ + Details of the Continuous Integration testing strategy + +`Bug reports `__ + How and where to report bugs and request features + +`Compiling `__ + How to compile libvirt + +`Goals `__ + Terminology and goals of libvirt API + +`API concepts `__ + The libvirt API concepts + +`API extensions `__ + Adding new public libvirt APIs + +`Event loop and worker pool `__ + Libvirt's event loop and worker pool mode + +`Spawning commands `__ + Spawning commands from libvirt driver code + +`RPC protocol & APIs `__ + RPC protocol information and API / dispatch guide + +`Lock managers `__ + Use lock managers to protect disk content + +`Functional testing `__ + Testing libvirt with + `TCK test suite `__ and + `Libvirt-test-API `__ + +`New repo setup `__ + Procedure for configuring new git repositories for libvirt diff --git a/docs/meson.build b/docs/meson.build index 75b5e4c08f..9e69a0dc05 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -18,7 +18,6 @@ docs_assets =3D [ ] docs_html_in_files =3D [ - 'docs', 'formatcaps', 'formatdomaincaps', 'formatnetwork', @@ -53,6 +52,7 @@ docs_rst_files =3D [ 'csharp', 'daemons', 'dbus', + 'docs', 'downloads', 'drivers', 'drvbhyve', --=20 2.35.1