From patchwork Tue May 21 12:25:17 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 164721 Delivered-To: patch@linaro.org Received: by 2002:a92:9e1a:0:0:0:0:0 with SMTP id q26csp1539854ili; Tue, 21 May 2019 05:29:44 -0700 (PDT) X-Google-Smtp-Source: APXvYqy1pO6Z8Qxx+dwi5Tv5ZC3iE1KEqPPkjr6TKqfYvk5N/h6L+O6j0iCGBDHwssTqdYOPrS+G X-Received: by 2002:a50:f9cc:: with SMTP id a12mr82771316edq.272.1558441784018; Tue, 21 May 2019 05:29:44 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1558441784; cv=none; d=google.com; s=arc-20160816; b=ePoFyZ/AflyFs6kD3E+07sNprRsRRhxIYYqNH8bZ1T4Z5X23OkHiZjeVuZiyI/TwhL wBuP6vDfRDnQ2ux4IVJn7yRUAgKH8JqhesZjgbCvygb4OIvz59gRMJJ26NE/PCmmiU3X qEQQgUkLdi2d0eAEQBUNyNiDC7nOCDQRbDE6gz1uZRUJpA2PT8EynrdD91/26l08lJOD y/MOZIJtTzh4xXyhHkgC1CGWdx8+gF2wCVqoVIQJXAGmFwY7bLPCo3Egv0I/vaW05jQV CGMFPk1Rtd5jR4tbblz6Lm5ek8EdOpQn+gBHmueY3waQRlCz1fkmW7ehuJcBYBCcYJZY +YDw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=hp1runAbdQd7C9+DO77cwqbwEDr2QCIxmTa56UZ3hFs=; b=ffxkExgVg2IF0rwDrBq/FCK7IPICucZTBpMKS6RlAqbpNwcP+JG3Urmbc2evUJ6ROV 5DU9WuKQqkod/0ruYKYt31XlqwaeFq5Cot+05I7SdP7wRY6WJh7rRSUtpjvqb3HLA3c9 Qodi1h3rc1qRZuR2HSdJfBCNG9qGuAzpOMMROqYnkNUVW+dk1wv1X2MeorQRuaUepHiv 0p0xCYw9IJExffrnodBfsBmY22Um2aLmRdKRifW2hX8Mr5teybjNmh8+aP6AnyYD8r40 /hAVDuLUrszDf5TBivOC3EE3OSwpiTCnbb7xU0VuVAcs0ldN+pkK+OMw7qY/D45YaVWU jEQQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=AhpuxbrH; 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=fail (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 k17si8579895ejz.93.2019.05.21.05.29.43 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 21 May 2019 05:29:44 -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=fail header.i=@linaro.org header.s=google header.b=AhpuxbrH; 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=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:52700 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hT3tm-0005Ei-VX for patch@linaro.org; Tue, 21 May 2019 08:29:43 -0400 Received: from eggs.gnu.org ([209.51.188.92]:45336) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hT3q2-0001SJ-SH for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:52 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hT3px-0005GF-2m for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:48 -0400 Received: from mail-wr1-x443.google.com ([2a00:1450:4864:20::443]:39691) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hT3pw-00059K-Ik for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:44 -0400 Received: by mail-wr1-x443.google.com with SMTP id w8so18400434wrl.6 for ; Tue, 21 May 2019 05:25:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=hp1runAbdQd7C9+DO77cwqbwEDr2QCIxmTa56UZ3hFs=; b=AhpuxbrHeNU/Dwg2zygsznoUNE1P7EkyIokpH4Mhd+mn7HR0ZpEXfqmaN8pFrVAtMG z5oWJzU24AM6MfUuNqkTyJja6ggTgDQlu0Rc919EBhi6yNI7u2P9LP000mg2bd7cjH7f m6rKf97vDJDv9XY15nDYr8BliQGE3ekUbmDby3yku3H0V0FFmGmLbWkL7rEiDNmbQ73i zdRrufTYQzM6F0HJ5vQlh8wsaPf2G2f4/ZSXKm25wMN1b0seZy6An7XJDYCZVO0PY1Af 3oV9gp/sQJ8T+enW786Okp5EfA6k0Edp2DG3LYUSDeO4upOKDpwtoUHO0Jy4VH5vwsf5 qmyw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=hp1runAbdQd7C9+DO77cwqbwEDr2QCIxmTa56UZ3hFs=; b=Dz8LmJhhT5qUCUl7tEz82OFb+NNy86xWJt+k1s8A3wMXiFrZrFCMrR7p3XDmCxGEU9 KpF2QmXRdIq19tZCoHCWvM25l1YUUgzkFX7lZnuYdj9wZpa1QrT1nkYi8fOfk81l7r2G toxintVEYL+8iakqvde+hMoPJTScUDfOUO7E0HNA5V5u2tcvlf8gfM9TRetY7weKmg3F 6D2PYvVJy7mA/emSK88PnzcyvMG5XIYsrKHB6NIbVcmVAqjVPKdrc+vqzc/0/ecNOYNg 0JDATLD6UFXujsn7FW0eVvd1uupmAp2ljQLf5BcWUIC0OjFRcI3KiAJoU7f+WG95XXHm 2JUw== X-Gm-Message-State: APjAAAXOo/TbyPTcpTK0St7mSxO7NoQtfLfGgj6r8N56jgmpAPhHhV+c 2NyFBJK51xNQlz37ZGBjRuobv17AOuE= X-Received: by 2002:adf:ba43:: with SMTP id t3mr43582893wrg.188.1558441533992; Tue, 21 May 2019 05:25:33 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id u11sm12233393wrn.1.2019.05.21.05.25.32 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 21 May 2019 05:25:33 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 21 May 2019 13:25:17 +0100 Message-Id: <20190521122519.12573-9-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190521122519.12573-1-peter.maydell@linaro.org> References: <20190521122519.12573-1-peter.maydell@linaro.org> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::443 Subject: [Qemu-devel] [RFC 08/10] docs: Add kernel-doc API documentation to memory.rst X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: "Daniel P. Berrange" , Eduardo Habkost , Gabriel Barreto , "Emilio G. Cota" , Stefan Hajnoczi , Cleber Rosa , Paolo Bonzini , John Snow Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" Add the API documentation as generated by kernel-doc to memory.rst. Signed-off-by: Peter Maydell --- Note that this generates errors that break the build, at least with the 1.7.5 version of Sphinx I'm currently using. --- docs/devel/memory.rst | 5 +++++ 1 file changed, 5 insertions(+) -- 2.20.1 diff --git a/docs/devel/memory.rst b/docs/devel/memory.rst index b6a4c37ea5e..68bc6202797 100644 --- a/docs/devel/memory.rst +++ b/docs/devel/memory.rst @@ -361,3 +361,8 @@ callbacks are called: - .impl.unaligned specifies that the *implementation* supports unaligned accesses; if false, unaligned accesses will be emulated by two aligned accesses. + +Detailed API documentation +-------------------------- + +.. kernel-doc:: include/exec/memory.h