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=-13.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,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 E151BC4338F for ; Wed, 4 Aug 2021 01:03:02 +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 6AFF660F58 for ; Wed, 4 Aug 2021 01:03:02 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 6AFF660F58 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:58760 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mB5JF-0003UF-Jw for qemu-devel@archiver.kernel.org; Tue, 03 Aug 2021 21:03:01 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54456) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mB5Cz-0000WA-4b for qemu-devel@nongnu.org; Tue, 03 Aug 2021 20:56:33 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:33833) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mB5Cx-0006m5-PR for qemu-devel@nongnu.org; Tue, 03 Aug 2021 20:56:32 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1628038591; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=zoDQcMj2O0CanL5RUdfTbw0wI0a9wNEoOK8bZtIqH0Y=; b=fzlhQxWFEcX5UdvqDjGvKgolo8xLMY/LKzSBXYY4VrSPMy7bE5kvagOfm9pe3MXAECCXUZ scioXUFZ1waJinFNJnJDXwuLV+71ozRcHVvPpgcxrtEgSUnFMnIe0HeopwzYqHpKBn8SIx zk4GOjITgp6JvAvR06KnyHqTgdQ0x4U= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-47-0f7YS6uzOvCa9-c7uXXOkw-1; Tue, 03 Aug 2021 20:56:28 -0400 X-MC-Unique: 0f7YS6uzOvCa9-c7uXXOkw-1 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id F1EFE801AEB; Wed, 4 Aug 2021 00:56:26 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.11.3]) by smtp.corp.redhat.com (Postfix) with ESMTP id 5D7B15D9DC; Wed, 4 Aug 2021 00:56:26 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH 5/6] docs/devel: create "Subsystem APIs" subsection Date: Tue, 3 Aug 2021 20:56:20 -0400 Message-Id: <20210804005621.1577302-6-jsnow@redhat.com> In-Reply-To: <20210804005621.1577302-1-jsnow@redhat.com> References: <20210804005621.1577302-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=jsnow@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII" Received-SPF: pass client-ip=216.205.24.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.699, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=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: John Snow , Peter Maydell , Daniel Berrange Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Signed-off-by: John Snow --- I tried to grab documents that appeared to document literal internal interfaces of QEMU (that weren't better described by some other subsection) and put them here in this section. Name isn't perfect, feel free to suggest alternatives. Signed-off-by: John Snow --- docs/devel/index.rst | 10 +--------- docs/devel/section-subsystems.rst | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 9 deletions(-) create mode 100644 docs/devel/section-subsystems.rst diff --git a/docs/devel/index.rst b/docs/devel/index.rst index 71ed48881ef..da579a7b666 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -13,19 +13,11 @@ modifying QEMU's source code. section-development section-testing-debugging section-tcg + section-subsystems control-flow-integrity - loads-stores - memory - migration - atomics decodetree - bitops - ui - reset s390-dasd-ipl - clocks qom - modules block-coroutine-wrapper multi-process ebpf_rss diff --git a/docs/devel/section-subsystems.rst b/docs/devel/section-subsystems.rst new file mode 100644 index 00000000000..fbe21f85adf --- /dev/null +++ b/docs/devel/section-subsystems.rst @@ -0,0 +1,16 @@ +Subsystem APIs +============== + +.. toctree:: + :maxdepth: 2 + :includehidden: + + atomics + bitops + loads-stores + clocks + memory + ui + migration + reset + modules -- 2.31.1