From nobody Mon Feb 9 11:05:51 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=1648469582; cv=none; d=zohomail.com; s=zohoarc; b=FSXV2+MM9MXLBA8tQ6eQFeCVG5KJFhKNkgig0nAUWRfmJJzJ55HVH4OQ1Yhnfn8M7y/rd4wXXhMALC0oIFjbbalCwIJYvbqux9kY6NmPnTCWU5dks9FspRCXjpJMeu4Tninx3zVIJZsLQKylGOCRZWtmwKOsmXcsSUZYWiDbk8c= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1648469582; 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=37GVtu0zMtHXeVPm7EPjTfuO2mI8T6MBYdJoMSy0UZM=; b=iMHCrdCr+jQWRCwk3ymvkkFPNo6mYRhAhj8zStZf3vWMYMO6iP1+uOvZfe+SvvdzZ5aF/ZkbrPf7iIG414T7XxgdD0AMOJnt0N+fBkmanVzSSLFM/67VjrHsap8cuIarofcaeAseTqf71rINgKFpICqF67YgTf3tqyKmNlOqVqI= 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 1648469582654304.2317367649481; Mon, 28 Mar 2022 05:13:02 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-244-OYxfxDwfPMKmk_u5sqnf-Q-1; Mon, 28 Mar 2022 08:11:10 -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 EF307899EC2; Mon, 28 Mar 2022 12:11:06 +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 DB1A040C1257; Mon, 28 Mar 2022 12:11:06 +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 9E4431940343; Mon, 28 Mar 2022 12:11:06 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id D2EB21947BBF for ; Mon, 28 Mar 2022 12:11:02 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id C5E201427AE5; Mon, 28 Mar 2022 12:11:02 +0000 (UTC) Received: from speedmetal.lan (unknown [10.40.208.35]) by smtp.corp.redhat.com (Postfix) with ESMTP id 43BAB1402642 for ; Mon, 28 Mar 2022 12:11:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1648469581; 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=37GVtu0zMtHXeVPm7EPjTfuO2mI8T6MBYdJoMSy0UZM=; b=ZYGDgmHDCo8yFJmMDnwcDcIsiYlf/kB0gkJcDZ1AUUtI7wf3WIwy5aQ3F8wCZvThA1YNc4 loRhoRyzZq5XzQkJBstBW6GYQQjGgBUaUaM+R3tf/mkQRfdpZfRZhB+/whY0X7aXO7ZNSG 3aVpCP8qu1UImAKMdFIfMg0n6sXdlA0= X-MC-Unique: OYxfxDwfPMKmk_u5sqnf-Q-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 16/29] docs: Convert 'format' page to rST Date: Mon, 28 Mar 2022 14:10:31 +0200 Message-Id: <08cfcae4155758416b9239787b3ba51a48296255.1648469356.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.7 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: 1648469583525100001 Content-Type: text/plain; charset="utf-8"; x-default="true" Signed-off-by: Peter Krempa --- docs/format.html.in | 48 --------------------------------------------- docs/format.rst | 35 +++++++++++++++++++++++++++++++++ docs/meson.build | 2 +- 3 files changed, 36 insertions(+), 49 deletions(-) delete mode 100644 docs/format.html.in create mode 100644 docs/format.rst diff --git a/docs/format.html.in b/docs/format.html.in deleted file mode 100644 index 1d2456de6f..0000000000 --- a/docs/format.html.in +++ /dev/null @@ -1,48 +0,0 @@ - - - - -

XML Format

- - -

- Objects in the libvirt API are configured using XML documents to all= ow - for ease of extension in future releases. Each XML document has an - associated Relax-NG schema that can be used to validate documents - prior to usage. -

- - - - -

Command line validation

- -

- The virt-xml-validate tool provides a simple command li= ne - for validating XML documents prior to giving them to libvirt. It uses - the locally installed RNG schema documents. It will auto-detect which - schema to use for validation based on the name of the top level elem= ent - in the input document. Thus it merely requires the XML document file= name - to be passed on the command line -

- - 
-$ virt-xml-validate /path/to/XML/file
- - - diff --git a/docs/format.rst b/docs/format.rst new file mode 100644 index 0000000000..a261007e73 --- /dev/null +++ b/docs/format.rst @@ -0,0 +1,35 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +XML Format +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Objects in the libvirt API are configured using XML documents to allow for= ease +of extension in future releases. Each XML document has an associated Relax= -NG +schema that can be used to validate documents prior to usage. + +- `Domains `__ +- `Networks `__ +- `Network filtering `__ +- `Network ports `__ +- `Storage `__ +- `Storage encryption `__ +- `Capabilities `__ +- `Domain capabilities `__ +- `Storage Pool capabilities `__ +- `Node devices `__ +- `Secrets `__ +- `Snapshots `__ +- `Checkpoints `__ +- `Backup jobs `__ + +Command line validation +----------------------- + +The ``virt-xml-validate`` tool provides a simple command line for validati= ng XML +documents prior to giving them to libvirt. It uses the locally installed R= NG +schema documents. It will auto-detect which schema to use for validation b= ased +on the name of the top level element in the input document. Thus it merely +requires the XML document filename to be passed on the command line + +:: + + $ virt-xml-validate /path/to/XML/file diff --git a/docs/meson.build b/docs/meson.build index aa8bad89f0..acc455c7c7 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -22,7 +22,6 @@ docs_html_in_files =3D [ 'csharp', 'dbus', 'docs', - 'format', 'formatcaps', 'formatdomaincaps', 'formatnetwork', @@ -82,6 +81,7 @@ docs_rst_files =3D [ 'drvxen', 'errors', 'firewall', + 'format', 'formatbackup', 'formatcheckpoint', 'formatdomain', --=20 2.35.1