{"id":1571487,"url":"http://patchwork.ozlabs.org/api/patches/1571487/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20211221065855.142578-23-marcandre.lureau@redhat.com/","project":{"id":14,"url":"http://patchwork.ozlabs.org/api/projects/14/?format=json","name":"QEMU Development","link_name":"qemu-devel","list_id":"qemu-devel.nongnu.org","list_email":"qemu-devel@nongnu.org","web_url":"","scm_url":"","webscm_url":"","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<20211221065855.142578-23-marcandre.lureau@redhat.com>","list_archive_url":null,"date":"2021-12-21T06:58:41","name":"[PULL,v2,22/36] docs: move D-Bus VMState documentation to source XML","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"3583e48d7c627eb80f22558899664653348822b8","submitter":{"id":66774,"url":"http://patchwork.ozlabs.org/api/people/66774/?format=json","name":"Marc-André Lureau","email":"marcandre.lureau@redhat.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20211221065855.142578-23-marcandre.lureau@redhat.com/mbox/","series":[{"id":277865,"url":"http://patchwork.ozlabs.org/api/series/277865/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/list/?series=277865","date":"2021-12-21T06:58:19","name":"[PULL,v2,01/36] ui/vdagent: add CHECK_SPICE_PROTOCOL_VERSION","version":2,"mbox":"http://patchwork.ozlabs.org/series/277865/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/1571487/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/1571487/checks/","tags":{},"related":[],"headers":{"Return-Path":"","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@bilbo.ozlabs.org","Authentication-Results":["bilbo.ozlabs.org;\n\tdkim=pass (1024-bit key;\n unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256\n header.s=mimecast20190719 header.b=TjseVMBN;\n\tdkim-atps=neutral","ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org\n (client-ip=209.51.188.17; helo=lists.gnu.org;\n envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n receiver=)","relay.mimecast.com;\n auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=marcandre.lureau@redhat.com"],"Received":["from lists.gnu.org (lists.gnu.org [209.51.188.17])\n\t(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))\n\t(No client certificate requested)\n\tby bilbo.ozlabs.org (Postfix) with ESMTPS id 4JJ7Zd2128z9s3q\n\tfor ; Tue, 21 Dec 2021 18:37:13 +1100 (AEDT)","from localhost ([::1]:41874 helo=lists1p.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.90_1)\n\t(envelope-from )\n\tid 1mzZhu-0008VM-PG\n\tfor incoming@patchwork.ozlabs.org; Tue, 21 Dec 2021 02:37:10 -0500","from eggs.gnu.org ([209.51.188.92]:58870)\n by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)\n (Exim 4.90_1) (envelope-from )\n id 1mzZD1-00088D-RF\n for qemu-devel@nongnu.org; Tue, 21 Dec 2021 02:05:17 -0500","from us-smtp-delivery-124.mimecast.com ([170.10.129.124]:41928)\n by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)\n (Exim 4.90_1) (envelope-from )\n id 1mzZCx-0002DB-Je\n for qemu-devel@nongnu.org; Tue, 21 Dec 2021 02:05:13 -0500","from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com\n [209.132.183.4]) by relay.mimecast.com with ESMTP with STARTTLS\n (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id\n us-mta-593-lb2ShXgCP_yPfWc4vUucdA-1; Tue, 21 Dec 2021 02:05:07 -0500","from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com\n [10.5.11.15])\n (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))\n (No client certificate requested)\n by mimecast-mx01.redhat.com (Postfix) with ESMTPS id BC0C61F2DA;\n Tue, 21 Dec 2021 07:04:56 +0000 (UTC)","from localhost (unknown [10.39.208.37])\n by smtp.corp.redhat.com (Postfix) with ESMTP id 861C877456;\n Tue, 21 Dec 2021 07:04:39 +0000 (UTC)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n s=mimecast20190719; t=1640070310;\n h=from:from:reply-to:subject:subject:date:date:message-id:message-id:\n to:to:cc:cc:mime-version:mime-version:content-type:content-type:\n content-transfer-encoding:content-transfer-encoding:\n in-reply-to:in-reply-to:references:references;\n bh=vSG78TuWGCC1NmuFibw5NVJmoaUqphOLxLa+Ev+PXQA=;\n b=TjseVMBNXa8w+1Zf+adaednx1Gai4CziPCPUvr3FALA4f+bzJcwVH/Tj2M14lcFxWZNlAD\n c13/uXMCnWYpKK1VyJOAMdGbpMuUgj64IQFg663yEwJa0zz8zzSuyVoH5MxpPfCKPwR3VK\n qcqOC8A1oOPERr9Ttm64x7ot0/qlML8=","X-MC-Unique":"lb2ShXgCP_yPfWc4vUucdA-1","From":"marcandre.lureau@redhat.com","To":"qemu-devel@nongnu.org","Subject":"[PULL v2 22/36] docs: move D-Bus VMState documentation to source XML","Date":"Tue, 21 Dec 2021 10:58:41 +0400","Message-Id":"<20211221065855.142578-23-marcandre.lureau@redhat.com>","In-Reply-To":"<20211221065855.142578-1-marcandre.lureau@redhat.com>","References":"<20211221065855.142578-1-marcandre.lureau@redhat.com>","MIME-Version":"1.0","X-Scanned-By":"MIMEDefang 2.79 on 10.5.11.15","X-Mimecast-Spam-Score":"0","X-Mimecast-Originator":"redhat.com","Content-Type":"text/plain; charset=UTF-8","Content-Transfer-Encoding":"8bit","Received-SPF":"pass client-ip=170.10.129.124;\n envelope-from=marcandre.lureau@redhat.com;\n helo=us-smtp-delivery-124.mimecast.com","X-Spam_score_int":"-29","X-Spam_score":"-3.0","X-Spam_bar":"---","X-Spam_report":"(-3.0 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.203,\n DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,\n RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001,\n SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no","X-Spam_action":"no action","X-BeenThere":"qemu-devel@nongnu.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n ","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n ","Cc":"peter.maydell@linaro.org, richard.henderson@linaro.org, =?utf-8?q?Marc-A?=\n\t=?utf-8?q?ndr=C3=A9_Lureau?= ","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"\"Qemu-devel\"\n "},"content":"From: Marc-André Lureau \n\nUse the source XML document as single reference, importing its\ndocumentation via the dbus-doc directive.\n\nSigned-off-by: Marc-André Lureau \nAcked-by: Gerd Hoffmann \n---\n docs/interop/dbus-vmstate.rst | 52 ++++++-----------------------------\n backends/dbus-vmstate1.xml | 42 +++++++++++++++++++++++++++-\n 2 files changed, 49 insertions(+), 45 deletions(-)","diff":"diff --git a/docs/interop/dbus-vmstate.rst b/docs/interop/dbus-vmstate.rst\nindex 1d719c1c604f..5fb3f279e280 100644\n--- a/docs/interop/dbus-vmstate.rst\n+++ b/docs/interop/dbus-vmstate.rst\n@@ -2,9 +2,6 @@\n D-Bus VMState\n =============\n \n-Introduction\n-============\n-\n The QEMU dbus-vmstate object's aim is to migrate helpers' data running\n on a QEMU D-Bus bus. (refer to the :doc:`dbus` document for\n some recommendations on D-Bus usage)\n@@ -26,49 +23,16 @@ dbus-vmstate object can be configured with the expected list of\n helpers by setting its ``id-list`` property, with a comma-separated\n ``Id`` list.\n \n-Interface\n-=========\n-\n-On object path ``/org/qemu/VMState1``, the following\n-``org.qemu.VMState1`` interface should be implemented:\n-\n-.. code:: xml\n-\n- \n- \n- \n- \n- \n- \n- \n- \n- \n-\n-\"Id\" property\n--------------\n-\n-A string that identifies the helper uniquely. (maximum 256 bytes\n-including terminating NUL byte)\n-\n-.. note::\n-\n- The helper ID namespace is a separate namespace. In particular, it is not\n- related to QEMU \"id\" used in -object/-device objects.\n-\n-Load(in u8[] bytes) method\n---------------------------\n-\n-The method called on destination with the state to restore.\n+.. only:: sphinx4\n \n-The helper may be initially started in a waiting state (with\n-an --incoming argument for example), and it may resume on success.\n+ .. dbus-doc:: backends/dbus-vmstate1.xml\n \n-An error may be returned to the caller.\n+.. only:: not sphinx4\n \n-Save(out u8[] bytes) method\n----------------------------\n+ .. warning::\n+ Sphinx 4 is required to build D-Bus documentation.\n \n-The method called on the source to get the current state to be\n-migrated. The helper should continue to run normally.\n+ This is the content of ``backends/dbus-vmstate1.xml``:\n \n-An error may be returned to the caller.\n+ .. literalinclude:: ../../backends/dbus-vmstate1.xml\n+ :language: xml\ndiff --git a/backends/dbus-vmstate1.xml b/backends/dbus-vmstate1.xml\nindex cc8563be4c92..601ee8dc7e4d 100644\n--- a/backends/dbus-vmstate1.xml\n+++ b/backends/dbus-vmstate1.xml\n@@ -1,10 +1,50 @@\n-\n+\n \n+ \n \n+\n+ \n \n+\n+ \n \n \n \n+\n+ \n \n \n \n","prefixes":["PULL","v2","22/36"]}