From nobody Tue Dec 16 03:19:48 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass(p=reject dis=none) header.from=lists.libvirt.org ARC-Seal: i=1; a=rsa-sha256; t=1743605145; cv=none; d=zohomail.com; s=zohoarc; b=PKBnFQg0QkKI21FeztfmMh2InYeVuDuUyixWU90Te0MPnQBrShRQrd1Clk5dvb0rSnk4oTvNnzwP40IeEyqQhv84dY6eRBH//b88JsJCj3RPnuc2uLxx04kL0vFDfIzli8VUJcAWuuinWAwV9/9QpIxzOQbCAQ50j487PGQ/PM8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1743605145; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=YkhGgtvrW+hiWWORu0y97FRYCFALXsJ4DgB2QnK4exQ=; b=XD60fT6TuJsQbhk9E8AtnxyALxS3d8HKfaPd/vkr9Tciqq67Eqq655EYt4GyjgUUJQoEJJR/UOTSwG4oYwkOIagoHW2Voc6CmgmgdnlCwAdKCHwVJEBohOEQwiA5IwP7pHtmRb+LTqze3N927HcOjJkexy79DJFnrP2kLxSXMtc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1743605145315979.8500098330743; Wed, 2 Apr 2025 07:45:45 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 01CDB1442; Wed, 2 Apr 2025 10:45:43 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 2B6F51417; Wed, 2 Apr 2025 10:45:22 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id DCE1913FB; Wed, 2 Apr 2025 10:45:18 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 1E8DFE74 for ; Wed, 2 Apr 2025 10:45:18 -0400 (EDT) Received: from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-322-gxDAkndoNuuI565bUZMUcw-1; Wed, 02 Apr 2025 10:45:16 -0400 Received: from mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.111]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 76EB0195609E for ; Wed, 2 Apr 2025 14:45:15 +0000 (UTC) Received: from speedmetal.lan (unknown [10.44.22.8]) by mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 8C9001801752 for ; Wed, 2 Apr 2025 14:45:14 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H5, RCVD_IN_MSPIKE_WL,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1743605117; h=from:from: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; bh=XkOS6t2Rc7ITWj28kx7Jwf1581154pjpZbyClgTg6kU=; b=CCVlAfY2FLY6R8JVBpoYkXEKMRRfc9xYc5SfGkcTpntUlo8pLUrDC/BNIOIqMfkP0zBNDn jc9j64v0pEMgDgBkl0ZJY7huVeAh+Wx+JE3CJE3EocWvxcFzyAOU5+EZdibCLlF+lrDkZA qwwmwmdJ7LSqx0aP/3J1f5OMPDT3bD8= X-MC-Unique: gxDAkndoNuuI565bUZMUcw-1 X-Mimecast-MFC-AGG-ID: gxDAkndoNuuI565bUZMUcw_1743605115 To: devel@lists.libvirt.org Subject: [PATCH 1/2] docs: Re-order XML schema after API documentation on 'docs' page Date: Wed, 2 Apr 2025 16:45:10 +0200 Message-ID: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.111 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: phO8VuczAwid6pG311VCJhl7ARwfbeuegg_x-Tb9HXM_1743605115 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: B52J5AH6MSXCOY3PR3FRHALGR5AMTFDZ X-Message-ID-Hash: B52J5AH6MSXCOY3PR3FRHALGR5AMTFDZ X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: From: Peter Krempa via Devel Reply-To: Peter Krempa X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1743605150132019100 Content-Type: text/plain; charset="utf-8" From: Peter Krempa Swap the order of links to XML schema docs and to the other language docs. The XML schema is usually accessed more. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/docs.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/docs.rst b/docs/docs.rst index 1a958e9cc7..1f16a11e90 100644 --- a/docs/docs.rst +++ b/docs/docs.rst @@ -79,19 +79,6 @@ Application development `QEMU `__, `LXC `__ libs -`Language bindings and API modules `__ - Bindings of the libvirt API for - `c# `__, - `go `__ (`all go modules `__), - `java `__, - `ocaml `__, - `perl `__, - `python `__, - `php `__, - `ruby `__ - and integration API modules for - `D-Bus `__ - `XML schemas `__ Description of the XML schemas for `domains `__, @@ -109,6 +96,19 @@ Application development `checkpoints `__, `backup jobs `__ +`Language bindings and API modules `__ + Bindings of the libvirt API for + `c# `__, + `go `__ (`all go modules `__), + `java `__, + `ocaml `__, + `perl `__, + `python `__, + `php `__, + `ruby `__ + and integration API modules for + `D-Bus `__ + `URI format `__ The URI formats used for connecting to libvirt --=20 2.49.0 From nobody Tue Dec 16 03:19:48 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass(p=reject dis=none) header.from=lists.libvirt.org ARC-Seal: i=1; a=rsa-sha256; t=1743605171; cv=none; d=zohomail.com; s=zohoarc; b=Jt79g+wYPfmisrfQxCsWd21g2FLhWrlutffLA+mcQncbDTp95IlqcxOiTigAqnomy3fBx6mgwJWQQPC6jiuHgCnbCQUV6qY0F/oP9krpE2yjHLKsnQpW4McMjVvTMW5uGxN/7IgGo7ROsoCmj/e5b0eO7PFlX9dXAr+KPJkawzo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1743605171; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=EDKeNbswqa93DMrktlVkZnjLhyDY6zQgddJT6BYjRvo=; b=FK2rKsdqqDIta/15eNmBDeR8rRWkQcgRE9SjuaJNfkLv133uH0UCfA9HwFfA8728d8egKItfNLsGFr4TlLiImDEFITxKqxmH8orDjGCwU4odj+GgdD5epbsDbpC8iUPxLVDd8Goprf0Z/gUj3EBnOAUDm+dd6XZQqDe3Scm8b2g= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1743605171006413.1969387023212; Wed, 2 Apr 2025 07:46:11 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id E6E5C1464; Wed, 2 Apr 2025 10:46:09 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 129A71545; Wed, 2 Apr 2025 10:45:24 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id ABFC51404; Wed, 2 Apr 2025 10:45:19 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 3034E13FB for ; Wed, 2 Apr 2025 10:45:19 -0400 (EDT) Received: from mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-482-XZowK49YP8Ca3KTD6BVR8g-1; Wed, 02 Apr 2025 10:45:17 -0400 Received: from mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.111]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id B73891801A12 for ; Wed, 2 Apr 2025 14:45:16 +0000 (UTC) Received: from speedmetal.lan (unknown [10.44.22.8]) by mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id D2E421801752 for ; Wed, 2 Apr 2025 14:45:15 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H5, RCVD_IN_MSPIKE_WL,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1743605118; h=from:from: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; bh=lk/iXsY1BQYdPHPwTbajM/h/WZj1Tp1I4+Og5t/o7GM=; b=T4i9awemCJNA6fRbLcYtZqIDAc5iRKUxukubKTjrgA4JGBgtA2Fca7iGplAhXeH3br5gdh 1HGJZ3sJ8dzi5cuceI2uJyI7CueASxdNask+oSLYdHsa6odYZ3UCocy1LTRGz5LMGpVn0S +djDLKygw0sudsas20kiy2ZjFAuBb0k= X-MC-Unique: XZowK49YP8Ca3KTD6BVR8g-1 X-Mimecast-MFC-AGG-ID: XZowK49YP8Ca3KTD6BVR8g_1743605116 To: devel@lists.libvirt.org Subject: [PATCH 2/2] docs: Render API and XML sections one per line in HTML Date: Wed, 2 Apr 2025 16:45:11 +0200 Message-ID: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.111 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: jqs6ynFJa4BtB4jgPcX4j2txgMn6a8B1bwl7raT573I_1743605116 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: YBDNOPE3TNGQ76W3FHW2JLVOWE6JMHRO X-Message-ID-Hash: YBDNOPE3TNGQ76W3FHW2JLVOWE6JMHRO X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: From: Peter Krempa via Devel Reply-To: Peter Krempa X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1743605173417019100 Content-Type: text/plain; charset="utf-8" From: Peter Krempa Finding the correct link to a XML description or API reference section in a big blob of links concatenated in a paragraph is unpleasand and especially for 'capabilities' and 'domain capabilities' following each other. Turn the API and XML reference sections into a list in RST and add CSS to fromat it a bit more compact. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/css/libvirt.css | 11 +++++++ docs/docs.rst | 69 ++++++++++++++++++++++++-------------------- 2 files changed, 48 insertions(+), 32 deletions(-) diff --git a/docs/css/libvirt.css b/docs/css/libvirt.css index 58ac1d385b..c80b1a54f6 100644 --- a/docs/css/libvirt.css +++ b/docs/css/libvirt.css @@ -123,6 +123,17 @@ img.diagram { margin-bottom: 1em; } +#documentation #application-development ul li p { + padding-bottom: 0px; + padding-top: 0px; +} + +#documentation #application-development ul { + margin-left: 2em; + padding-top: 0px; + padding-bottom: 0px; +} + .removedhv { color: darkred; } diff --git a/docs/docs.rst b/docs/docs.rst index 1f16a11e90..09939c1201 100644 --- a/docs/docs.rst +++ b/docs/docs.rst @@ -60,41 +60,46 @@ 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 + 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 the documentation for the API of the additional libs: + + * `admin `__ + * `QEMU `__ + * `LXC `__ `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 `__ + + * `domains `__ + * `networks `__ + * `network ports `__ + * `network filtering `__ + * `storage `__ + * `storage encryption `__ + * `capabilities `__ + * `domain capabilities `__ + * `storage pool capabilities `__ + * `node devices `__ + * `secrets `__ + * `snapshots `__ + * `checkpoints `__ + * `backup jobs `__ `Language bindings and API modules `__ Bindings of the libvirt API for --=20 2.49.0