From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-10.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,HTML_MESSAGE,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8D9A3C433B4 for ; Tue, 27 Apr 2021 08:41:26 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 9782761159 for ; Tue, 27 Apr 2021 08:41:25 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 9782761159 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:47282 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lbJHY-0004Rs-Er for qemu-devel@archiver.kernel.org; Tue, 27 Apr 2021 04:41:24 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43318) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lbJGN-0003H5-Rw for qemu-devel@nongnu.org; Tue, 27 Apr 2021 04:40:13 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:56669) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lbJGK-0000S8-5S for qemu-devel@nongnu.org; Tue, 27 Apr 2021 04:40:11 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1619512806; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=FsPvQNXtqCy6i44n3tbca4U3FQoJ6fVRhKMfTpMEReQ=; b=feLTB2QCFG8fH0CyD/sgNipE4r8xx3lhfr2TRcdiwPWPRyJge9mtULYHgi7/WwwGX4112U rJPusIdB5qqUkkrwIUclppo+WDmHaeNaodOLGH1Yq3zFShyMTAL90pdvmBkEAPuVEDUTQO wduEq7c+GS89GLeUBVDgt5TurQSl1NU= Received: from mail-pl1-f197.google.com (mail-pl1-f197.google.com [209.85.214.197]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-280-VJG4hkg9PgOI0kzNfDBgBw-1; Tue, 27 Apr 2021 04:39:13 -0400 X-MC-Unique: VJG4hkg9PgOI0kzNfDBgBw-1 Received: by mail-pl1-f197.google.com with SMTP id m8-20020a170902db08b02900ecafbf66bbso11800951plx.11 for ; Tue, 27 Apr 2021 01:39:12 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=FsPvQNXtqCy6i44n3tbca4U3FQoJ6fVRhKMfTpMEReQ=; b=C329I2+oUyAKdHQxlQKD84W/aFWu7L3r4cpHTAJRcqrI0zcJUf4D64ai4FpRc90lvv UBc8pg4c1Em45lDHqwoyYQOCcpPDPFXIS4mOyMG7kuAy8f93DNbtROluRZgiIt+RnQNH TxAiQVE6HPutDzsQL99IufZ7pG+7BcJ1w+qGocezuw1tHbby4hMbG+L18h3ZF2uvOd8H 2x9eOl75R9lhkieDjNkT66qWen++X5g8vL1ayDtcH0OZ/afTQzkJr5PB/wXfTyCa4TmL lnxcRZMapcCgEYgP8KpbAY76ZU/9v+PdpLHdUN1i4EVpPFiZl2hZdGg3RRZgl1MWWrd2 Sbqg== X-Gm-Message-State: AOAM530+jDQrU5eJ2hpSR/JkMlHnVMpmRpQ8bDSzYsBcBzLvJPo1mglB zEUvnGnhmykdLR4TXHfdql8mHNfHLcfifb0zBeVScMA+pdQrCVK3DQmkTby2RuEPHd0F3r0mWpv mtdjqBKfp+w87ikQP91dEluwEHHhB9Og= X-Received: by 2002:a17:90a:8d82:: with SMTP id d2mr25687926pjo.200.1619512751907; Tue, 27 Apr 2021 01:39:11 -0700 (PDT) X-Google-Smtp-Source: ABdhPJz8n9f2GLfWmRH/my/gnmyooTfPVy7tUItYL/w54ZW6dCKizpdXxCs935kWRwO2TZdA6UZf3mwZ3kGEDoJcmFc= X-Received: by 2002:a17:90a:8d82:: with SMTP id d2mr25687911pjo.200.1619512751717; Tue, 27 Apr 2021 01:39:11 -0700 (PDT) MIME-Version: 1.0 References: <20210423083351.2096734-1-kraxel@redhat.com> <20210423083351.2096734-4-kraxel@redhat.com> In-Reply-To: <20210423083351.2096734-4-kraxel@redhat.com> From: =?UTF-8?B?TWFyYy1BbmRyw6kgTHVyZWF1?= Date: Tue, 27 Apr 2021 12:39:00 +0400 Message-ID: Subject: Re: [PATCH v4 3/9] ui: add clipboard documentation To: Gerd Hoffmann Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=mlureau@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: multipart/alternative; boundary="00000000000046a3b805c0f03223" Received-SPF: pass client-ip=216.205.24.124; envelope-from=mlureau@redhat.com; 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.219, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, 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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Paolo Bonzini , qemu-devel , Markus Armbruster Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" --00000000000046a3b805c0f03223 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable On Fri, Apr 23, 2021 at 12:34 PM Gerd Hoffmann wrote: > Document clipboard infrastructure in qemu. > > Signed-off-by: Gerd Hoffmann > --- > include/ui/clipboard.h | 133 ++++++++++++++++++++++++++++++++++++++++- > docs/devel/index.rst | 1 + > docs/devel/ui.rst | 8 +++ > 3 files changed, 141 insertions(+), 1 deletion(-) > create mode 100644 docs/devel/ui.rst > > Reviewed-by: Marc-Andr=C3=A9 Lureau diff --git a/include/ui/clipboard.h b/include/ui/clipboard.h > index b2354a4162db..57d4ad445628 100644 > --- a/include/ui/clipboard.h > +++ b/include/ui/clipboard.h > @@ -3,17 +3,47 @@ > > #include "qemu/notify.h" > > +/** > + * DOC: Introduction > + * > + * The header ``ui/clipboard.h`` declares the qemu clipboard interface. > + * > + * All qemu elements which want use the clipboard can register as > + * clipboard peer. Subsequently they can set the clipboard content > + * and get notifications for clipboard updates. > + * > + * Typical users are user interfaces (gtk), remote access protocols > + * (vnc) and devices talking to the guest (vdagent). > + * > + * Even though the design allows different data types only plain text > + * is supported for now. > + */ > + > typedef enum QemuClipboardType QemuClipboardType; > typedef enum QemuClipboardSelection QemuClipboardSelection; > typedef struct QemuClipboardPeer QemuClipboardPeer; > typedef struct QemuClipboardInfo QemuClipboardInfo; > > +/** > + * enum QemuClipboardType > + * > + * @QEMU_CLIPBOARD_TYPE_TEXT: text/plain; charset=3Dutf-8 > + * @QEMU_CLIPBOARD_TYPE__COUNT: type count. > + */ > enum QemuClipboardType { > - QEMU_CLIPBOARD_TYPE_TEXT, /* text/plain; charset=3Dutf-8 */ > + QEMU_CLIPBOARD_TYPE_TEXT, > QEMU_CLIPBOARD_TYPE__COUNT, > }; > > /* same as VD_AGENT_CLIPBOARD_SELECTION_* */ > +/** > + * enum QemuClipboardSelection > + * > + * @QEMU_CLIPBOARD_SELECTION_CLIPBOARD: clipboard (explitcit cut+paste). > + * @QEMU_CLIPBOARD_SELECTION_PRIMARY: primary selection (select + middle > mouse button). > + * @QEMU_CLIPBOARD_SELECTION_SECONDARY: secondary selection (dunno). > + * @QEMU_CLIPBOARD_SELECTION__COUNT: selection count. > + */ > enum QemuClipboardSelection { > QEMU_CLIPBOARD_SELECTION_CLIPBOARD, > QEMU_CLIPBOARD_SELECTION_PRIMARY, > @@ -21,6 +51,15 @@ enum QemuClipboardSelection { > QEMU_CLIPBOARD_SELECTION__COUNT, > }; > > +/** > + * struct QemuClipboardPeer > + * > + * @name: peer name. > + * @update: notifier for clipboard updates. > + * @request: callback for clipboard data requests. > + * > + * Clipboard peer description. > + */ > struct QemuClipboardPeer { > const char *name; > Notifier update; > @@ -28,6 +67,16 @@ struct QemuClipboardPeer { > QemuClipboardType type); > }; > > +/** > + * struct QemuClipboardInfo > + * > + * @refcount: reference counter. > + * @owner: clipboard owner. > + * @selection: clipboard selection. > + * @types: clipboard data array (one entry per type). > + * > + * Clipboard content data and metadata. > + */ > struct QemuClipboardInfo { > uint32_t refcount; > QemuClipboardPeer *owner; > @@ -40,18 +89,100 @@ struct QemuClipboardInfo { > } types[QEMU_CLIPBOARD_TYPE__COUNT]; > }; > > +/** > + * qemu_clipboard_peer_register > + * > + * @peer: peer information. > + * > + * Register clipboard peer. Registering is needed for both active > + * (set+grab clipboard) and passive (watch clipboard for updates) > + * interaction with the qemu clipboard. > + */ > void qemu_clipboard_peer_register(QemuClipboardPeer *peer); > + > +/** > + * qemu_clipboard_peer_unregister > + * > + * @peer: peer information. > + * > + * Unregister clipboard peer. > + */ > void qemu_clipboard_peer_unregister(QemuClipboardPeer *peer); > > +/** > + * qemu_clipboard_info_new > + * > + * @owner: clipboard owner. > + * @selection: clipboard selection. > + * > + * Allocate a new QemuClipboardInfo and initialize it with the given > + * @owner and @selection. > + * > + * QemuClipboardInfo is a reference-counted struct. The new struct is > + * returned with a reference already taken (i.e. reference count is > + * one). > + */ > QemuClipboardInfo *qemu_clipboard_info_new(QemuClipboardPeer *owner, > QemuClipboardSelection > selection); > +/** > + * qemu_clipboard_info_get > + * > + * @info: clipboard info. > + * > + * Increase @info reference count. > + */ > QemuClipboardInfo *qemu_clipboard_info_get(QemuClipboardInfo *info); > + > +/** > + * qemu_clipboard_info_put > + * > + * @info: clipboard info. > + * > + * Decrease @info reference count. When the count goes down to zero > + * free the @info struct itself and all clipboard data. > + */ > void qemu_clipboard_info_put(QemuClipboardInfo *info); > > +/** > + * qemu_clipboard_update > + * > + * @info: clipboard info. > + * > + * Update the qemu clipboard. Notify all registered peers (including > + * the clipboard owner) that the qemu clipboard has been updated. > + * > + * This is used for both new completely clipboard content and for > + * clipboard data updates in response to qemu_clipboard_request() > + * calls. > + */ > void qemu_clipboard_update(QemuClipboardInfo *info); > + > +/** > + * qemu_clipboard_request > + * > + * @info: clipboard info. > + * @type: clipboard data type. > + * > + * Request clipboard content. Typically the clipboard owner only > + * advertises the available data types and provides the actual data > + * only on request. > + */ > void qemu_clipboard_request(QemuClipboardInfo *info, > QemuClipboardType type); > > +/** > + * qemu_clipboard_set_data > + * > + * @peer: clipboard peer. > + * @info: clipboard info. > + * @type: clipboard data type. > + * @size: data size. > + * @data: data blob. > + * @update: notify peers about the update. > + * > + * Set clipboard content for the given @type. This function will make > + * a copy of the content data and store that. > + */ > void qemu_clipboard_set_data(QemuClipboardPeer *peer, > QemuClipboardInfo *info, > QemuClipboardType type, > diff --git a/docs/devel/index.rst b/docs/devel/index.rst > index 6cf7e2d2330c..cbdbb9049182 100644 > --- a/docs/devel/index.rst > +++ b/docs/devel/index.rst > @@ -36,6 +36,7 @@ Contents: > multi-thread-tcg > tcg-plugins > bitops > + ui > reset > s390-dasd-ipl > clocks > diff --git a/docs/devel/ui.rst b/docs/devel/ui.rst > new file mode 100644 > index 000000000000..06c7d622ce74 > --- /dev/null > +++ b/docs/devel/ui.rst > @@ -0,0 +1,8 @@ > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > +Qemu UI subsystem > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +Qemu Clipboard > +-------------- > + > +.. kernel-doc:: include/ui/clipboard.h > -- > 2.30.2 > > --00000000000046a3b805c0f03223 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable


=
On Fri, Apr 23, 2021 at 12:34 PM Gerd= Hoffmann <kraxel@redhat.com>= ; wrote:
Documen= t clipboard infrastructure in qemu.

Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
---
=C2=A0include/ui/clipboard.h | 133 ++++++++++++++++++++++++++++++++++++++++= -
=C2=A0docs/devel/index.rst=C2=A0 =C2=A0|=C2=A0 =C2=A01 +
=C2=A0docs/devel/ui.rst=C2=A0 =C2=A0 =C2=A0 |=C2=A0 =C2=A08 +++
=C2=A03 files changed, 141 insertions(+), 1 deletion(-)
=C2=A0create mode 100644 docs/devel/ui.rst


Reviewed-by: Marc-Andr=C3=A9 Lureau &l= t;marcandre.lureau@redhat.co= m>=C2=A0

diff --git a/include/ui/clipboard.h b/include/ui/clipboard.h
index b2354a4162db..57d4ad445628 100644
--- a/include/ui/clipboard.h
+++ b/include/ui/clipboard.h
@@ -3,17 +3,47 @@

=C2=A0#include "qemu/notify.h"

+/**
+ * DOC: Introduction
+ *
+ * The header ``ui/clipboard.h`` declares the qemu clipboard interface. + *
+ * All qemu elements which want use the clipboard can register as
+ * clipboard peer.=C2=A0 Subsequently they can set the clipboard content + * and get notifications for clipboard updates.
+ *
+ * Typical users are user interfaces (gtk), remote access protocols
+ * (vnc) and devices talking to the guest (vdagent).
+ *
+ * Even though the design allows different data types only plain text
+ * is supported for now.
+ */
+
=C2=A0typedef enum QemuClipboardType QemuClipboardType;
=C2=A0typedef enum QemuClipboardSelection QemuClipboardSelection;
=C2=A0typedef struct QemuClipboardPeer QemuClipboardPeer;
=C2=A0typedef struct QemuClipboardInfo QemuClipboardInfo;

+/**
+ * enum QemuClipboardType
+ *
+ * @QEMU_CLIPBOARD_TYPE_TEXT: text/plain; charset=3Dutf-8
+ * @QEMU_CLIPBOARD_TYPE__COUNT: type count.
+ */
=C2=A0enum QemuClipboardType {
-=C2=A0 =C2=A0 QEMU_CLIPBOARD_TYPE_TEXT,=C2=A0 /* text/plain; charset=3Dutf= -8 */
+=C2=A0 =C2=A0 QEMU_CLIPBOARD_TYPE_TEXT,
=C2=A0 =C2=A0 =C2=A0QEMU_CLIPBOARD_TYPE__COUNT,
=C2=A0};

=C2=A0/* same as VD_AGENT_CLIPBOARD_SELECTION_* */
+/**
+ * enum QemuClipboardSelection
+ *
+ * @QEMU_CLIPBOARD_SELECTION_CLIPBOARD: clipboard (explitcit cut+paste). + * @QEMU_CLIPBOARD_SELECTION_PRIMARY: primary selection (select + middle m= ouse button).
+ * @QEMU_CLIPBOARD_SELECTION_SECONDARY: secondary selection (dunno).
+ * @QEMU_CLIPBOARD_SELECTION__COUNT: selection count.
+ */
=C2=A0enum QemuClipboardSelection {
=C2=A0 =C2=A0 =C2=A0QEMU_CLIPBOARD_SELECTION_CLIPBOARD,
=C2=A0 =C2=A0 =C2=A0QEMU_CLIPBOARD_SELECTION_PRIMARY,
@@ -21,6 +51,15 @@ enum QemuClipboardSelection {
=C2=A0 =C2=A0 =C2=A0QEMU_CLIPBOARD_SELECTION__COUNT,
=C2=A0};

+/**
+ * struct QemuClipboardPeer
+ *
+ * @name: peer name.
+ * @update: notifier for clipboard updates.
+ * @request: callback for clipboard data requests.
+ *
+ * Clipboard peer description.
+ */
=C2=A0struct QemuClipboardPeer {
=C2=A0 =C2=A0 =C2=A0const char *name;
=C2=A0 =C2=A0 =C2=A0Notifier update;
@@ -28,6 +67,16 @@ struct QemuClipboardPeer {
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2= =A0QemuClipboardType type);
=C2=A0};

+/**
+ * struct QemuClipboardInfo
+ *
+ * @refcount: reference counter.
+ * @owner: clipboard owner.
+ * @selection: clipboard selection.
+ * @types: clipboard data array (one entry per type).
+ *
+ * Clipboard content data and metadata.
+ */
=C2=A0struct QemuClipboardInfo {
=C2=A0 =C2=A0 =C2=A0uint32_t refcount;
=C2=A0 =C2=A0 =C2=A0QemuClipboardPeer *owner;
@@ -40,18 +89,100 @@ struct QemuClipboardInfo {
=C2=A0 =C2=A0 =C2=A0} types[QEMU_CLIPBOARD_TYPE__COUNT];
=C2=A0};

+/**
+ * qemu_clipboard_peer_register
+ *
+ * @peer: peer information.
+ *
+ * Register clipboard peer.=C2=A0 Registering is needed for both active + * (set+grab clipboard) and passive (watch clipboard for updates)
+ * interaction with the qemu clipboard.
+ */
=C2=A0void qemu_clipboard_peer_register(QemuClipboardPeer *peer);
+
+/**
+ * qemu_clipboard_peer_unregister
+ *
+ * @peer: peer information.
+ *
+ * Unregister clipboard peer.
+ */
=C2=A0void qemu_clipboard_peer_unregister(QemuClipboardPeer *peer);

+/**
+ * qemu_clipboard_info_new
+ *
+ * @owner: clipboard owner.
+ * @selection: clipboard selection.
+ *
+ * Allocate a new QemuClipboardInfo and initialize it with the given
+ * @owner and @selection.
+ *
+ * QemuClipboardInfo is a reference-counted struct.=C2=A0 The new struct i= s
+ * returned with a reference already taken (i.e. reference count is
+ * one).
+ */
=C2=A0QemuClipboardInfo *qemu_clipboard_info_new(QemuClipboardPeer *owner,<= br> =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2= =A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 = =C2=A0 QemuClipboardSelection selection);
+/**
+ * qemu_clipboard_info_get
+ *
+ * @info: clipboard info.
+ *
+ * Increase @info reference count.
+ */
=C2=A0QemuClipboardInfo *qemu_clipboard_info_get(QemuClipboardInfo *info);<= br> +
+/**
+ * qemu_clipboard_info_put
+ *
+ * @info: clipboard info.
+ *
+ * Decrease @info reference count.=C2=A0 When the count goes down to zero<= br> + * free the @info struct itself and all clipboard data.
+ */
=C2=A0void qemu_clipboard_info_put(QemuClipboardInfo *info);

+/**
+ * qemu_clipboard_update
+ *
+ * @info: clipboard info.
+ *
+ * Update the qemu clipboard.=C2=A0 Notify all registered peers (including=
+ * the clipboard owner) that the qemu clipboard has been updated.
+ *
+ * This is used for both new completely clipboard content and for
+ * clipboard data updates in response to qemu_clipboard_request()
+ * calls.
+ */
=C2=A0void qemu_clipboard_update(QemuClipboardInfo *info);
+
+/**
+ * qemu_clipboard_request
+ *
+ * @info: clipboard info.
+ * @type: clipboard data type.
+ *
+ * Request clipboard content.=C2=A0 Typically the clipboard owner only
+ * advertises the available data types and provides the actual data
+ * only on request.
+ */
=C2=A0void qemu_clipboard_request(QemuClipboardInfo *info,
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2= =A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0QemuClipboardType type);

+/**
+ * qemu_clipboard_set_data
+ *
+ * @peer: clipboard peer.
+ * @info: clipboard info.
+ * @type: clipboard data type.
+ * @size: data size.
+ * @data: data blob.
+ * @update: notify peers about the update.
+ *
+ * Set clipboard content for the given @type.=C2=A0 This function will mak= e
+ * a copy of the content data and store that.
+ */
=C2=A0void qemu_clipboard_set_data(QemuClipboardPeer *peer,
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2= =A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 QemuClipboardInfo *info,
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2= =A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 QemuClipboardType type,
diff --git a/docs/devel/index.rst b/docs/devel/index.rst
index 6cf7e2d2330c..cbdbb9049182 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -36,6 +36,7 @@ Contents:
=C2=A0 =C2=A0 multi-thread-tcg
=C2=A0 =C2=A0 tcg-plugins
=C2=A0 =C2=A0 bitops
+=C2=A0 =C2=A0ui
=C2=A0 =C2=A0 reset
=C2=A0 =C2=A0 s390-dasd-ipl
=C2=A0 =C2=A0 clocks
diff --git a/docs/devel/ui.rst b/docs/devel/ui.rst
new file mode 100644
index 000000000000..06c7d622ce74
--- /dev/null
+++ b/docs/devel/ui.rst
@@ -0,0 +1,8 @@
+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
+Qemu UI subsystem
+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
+
+Qemu Clipboard
+--------------
+
+.. kernel-doc:: include/ui/clipboard.h
--
2.30.2

--00000000000046a3b805c0f03223--