From patchwork Tue Jun 27 16:09:31 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 696891 Delivered-To: patch@linaro.org Received: by 2002:adf:e885:0:0:0:0:0 with SMTP id d5csp3868356wrm; Tue, 27 Jun 2023 09:17:51 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ4rPgV/sFTD2nFFmCy3EjlrWWnvxJKUc+qLDEWutQaGoYz9nB/9yrcjyYbLDq6TRqgllk3O X-Received: by 2002:a05:6214:528f:b0:62d:ddeb:3789 with SMTP id kj15-20020a056214528f00b0062dddeb3789mr16425218qvb.43.1687882671241; Tue, 27 Jun 2023 09:17:51 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1687882671; cv=none; d=google.com; s=arc-20160816; b=UyYSTYFD/XbF/5qXDja/Id0I1sjrRq8heZDRBb3xR4B58md3E+I8TUJ/zvifQ1D4Ml M9n9cOD/MIz6exPMPDm9bQUuNpyELeyUb4vSnjsjEy3h12K24s0foTnQ8QSMGsbUIJ3x xA/G2l71Ly1atN2V9WOgoL8VA3CcBAqVywhJ69qN5o9D+BP+mj4v9J50EklT99eLBfa8 odsyTn9vgiTbsDkzS7DJ7bs0l0wPshZ6pRllLY8+y7hHa2KCBopnzwBRVRLQpFO/Jzca g0JW2qawUEUxKRAzqkC7QduQaTpBZ/rh6OMCZfslIUp5GFr8YncH1NQr/hOZ+PWkUrvg gsww== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=MH8q2iOgTUeX14EJZw8vp3pnXPRkiEedRymAvSCpuUo=; fh=ArV5Yx1z9lg+jufSSsiXTUg87d1rJ5PmrQDHLSB2i58=; b=yLQsPfaTU6ba+T7czEU62/+o3JXU8ksXL7Dy2CbTGsd3dyLSdi8efV7inSIQoIVJDn GS4d2WjaHPtxcKOB5ouGSHSf/Q1il0cfMGwig5DVMvR1S7l3fRGOj+GADNwpIJEV6Qye Xi/JA1aksAkbN4fc9KPTAkVXuF3P+Gd0WIRIS7DNWwZ3KKzfk4UVN3EnqF5vixA8/pcv 3iP3N40GrHfWNj2d4ITVtCrDS1N0Fo15WPmCf0aTuLERsUpzzdYL3Jtr0IhgIYfI1mFt +/teWvZMNz01H/+tv877vbER5ag8YYw55s1Pz7W3y9TFSr5JuQNXvLuoej/beGR6/Yfv E1KA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=DdoZxOLN; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id z1-20020a056214040100b0062fe9266d13si3458446qvx.439.2023.06.27.09.17.51 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Tue, 27 Jun 2023 09:17:51 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=DdoZxOLN; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qEBMG-00011G-Ug; Tue, 27 Jun 2023 12:16:00 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qEBMF-0000z2-Ed for qemu-devel@nongnu.org; Tue, 27 Jun 2023 12:15:59 -0400 Received: from mail-wm1-x333.google.com ([2a00:1450:4864:20::333]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qEBMA-000894-Gj for qemu-devel@nongnu.org; Tue, 27 Jun 2023 12:15:59 -0400 Received: by mail-wm1-x333.google.com with SMTP id 5b1f17b1804b1-3fa96fd79feso28513345e9.2 for ; Tue, 27 Jun 2023 09:15:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1687882553; x=1690474553; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=MH8q2iOgTUeX14EJZw8vp3pnXPRkiEedRymAvSCpuUo=; b=DdoZxOLN+AvjXoCRjUIs4sxtM6xjeJtnVRAiZaPPV/Af6XT+Ht3QnEGPuV0BPQ3BC3 DCksIEuF/7WM78vkBqJ/lpXOdWc+Gf3xGT84ZjSOP144lEvGDqLuZybzwKgfcfsHgjMs kwe7eTmWGFUAiiZ8Hl6kyRXwBtH6FGSz8yfM9g2MHdmQOtA33Tynkq/7Vsd+U/vlSVK0 cknZz9qFxB4wY8BKaXlAQYD2fgxXKPWP74ygjHKRCx4QvkBDgMZgl/IbsRo83r6jtWGi +f6YCASZhM1lPFuOWMHcoRYzzgvcez1l5duW8Ohraz3lhV3yFLS7mqQmeiFOC+zznouD q9ag== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1687882553; x=1690474553; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=MH8q2iOgTUeX14EJZw8vp3pnXPRkiEedRymAvSCpuUo=; b=J5Z/v2BCqPlFb0AKFYos+F5e/9j0rmcwY22WIO98k/7i6yOQS9yYZFNc66a7E3gRPB toCr7Tl3m8RMY+c8zgQLPdIWpxtZkRnd0jGYszd8reXJjdI0uLY/u+98/pCVgBO7zcwS Hy53tCz+rMyFz9FRCUhENsS0Nea39zlmK8vadQCQHOFhH+JnIxeAPl+dNAXATghjD1vS bT/78gAXWZUXpXnHSdrPxsIz6qSkCQyrGbsj/x8+sSAXgtUHvp1f5UMf1H2R26/jWXfm 5VB5wPmepN4h9vJtNC2U3QodPUkZU4zbt7ztShVdvyXyRrYWPdoNovGFMCKX/eu9DvV2 JLZA== X-Gm-Message-State: AC+VfDxKBljCiheBW3wBCIjOoe5HpUVQQUPsMpJYzK/Z51LKBSltji+8 Ku0stsrZQYAjLuqDGZPtSWQmQg== X-Received: by 2002:a1c:791a:0:b0:3fa:76e2:e6d5 with SMTP id l26-20020a1c791a000000b003fa76e2e6d5mr12256709wme.37.1687882552815; Tue, 27 Jun 2023 09:15:52 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id i5-20020a05600c290500b003f9b66a9376sm14234527wmd.42.2023.06.27.09.15.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Jun 2023 09:15:50 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id C99821FFC1; Tue, 27 Jun 2023 17:09:46 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Wainer dos Santos Moschetta , Juan Quintela , Thomas Huth , Cleber Rosa , Leonardo Bras , Beraldo Leal , Peter Maydell , Bin Meng , Yanan Wang , Darren Kenny , Alexander Bulekov , Marcel Apfelbaum , Peter Xu , Radoslaw Biernacki , Laurent Vivier , Paolo Bonzini , Eduardo Habkost , qemu-arm@nongnu.org, Stefan Hajnoczi , Richard Henderson , Bandan Das , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , =?utf-8?q?Dani?= =?utf-8?q?el_P=2E_Berrang=C3=A9?= , Alexandre Iooss , Marcin Juszkiewicz , Leif Lindholm , Laurent Vivier , Qiuhao Li , Mahmoud Mandour , Riku Voipio , =?utf-8?q?Alex_Benn=C3=A9e?= Subject: [PATCH v3 24/36] docs/devel: split qom-api reference into new file Date: Tue, 27 Jun 2023 17:09:31 +0100 Message-Id: <20230627160943.2956928-25-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230627160943.2956928-1-alex.bennee@linaro.org> References: <20230627160943.2956928-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::333; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x333.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=unavailable 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: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org Lets try and keep the overview of the sub-system digestible by splitting the core API stuff into a separate file. As QOM and QDEV work together we should also try and enumerate the qdev_ functions. Reviewed-by: Philippe Mathieu-Daudé Signed-off-by: Alex Bennée Message-Id: <20230619171437.357374-5-alex.bennee@linaro.org> --- v2 - also include qdev API --- docs/devel/index-api.rst | 2 ++ docs/devel/qdev-api.rst | 7 +++++++ docs/devel/qom-api.rst | 9 +++++++++ docs/devel/qom.rst | 3 ++- 4 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 docs/devel/qdev-api.rst create mode 100644 docs/devel/qom-api.rst diff --git a/docs/devel/index-api.rst b/docs/devel/index-api.rst index 7108821746..539ad29c21 100644 --- a/docs/devel/index-api.rst +++ b/docs/devel/index-api.rst @@ -11,5 +11,7 @@ generated from in-code annotations to function prototypes. loads-stores memory modules + qom-api + qdev-api ui zoned-storage diff --git a/docs/devel/qdev-api.rst b/docs/devel/qdev-api.rst new file mode 100644 index 0000000000..3f35eea025 --- /dev/null +++ b/docs/devel/qdev-api.rst @@ -0,0 +1,7 @@ +.. _qdev-api: + +================================ +QEMU Device (qdev) API Reference +================================ + +.. kernel-doc:: include/hw/qdev-core.h diff --git a/docs/devel/qom-api.rst b/docs/devel/qom-api.rst new file mode 100644 index 0000000000..ed1f17e797 --- /dev/null +++ b/docs/devel/qom-api.rst @@ -0,0 +1,9 @@ +.. _qom-api: + +===================================== +QEMU Object Model (QOM) API Reference +===================================== + +This is the complete API documentation for :ref:`qom`. + +.. kernel-doc:: include/qom/object.h diff --git a/docs/devel/qom.rst b/docs/devel/qom.rst index 2828843058..c342ce18e3 100644 --- a/docs/devel/qom.rst +++ b/docs/devel/qom.rst @@ -387,4 +387,5 @@ OBJECT_DEFINE_ABSTRACT_TYPE() macro can be used instead: API Reference ------------- -.. kernel-doc:: include/qom/object.h +See the :ref:`QOM API` and :ref:`QDEV API` +documents for the complete API description.