From patchwork Wed Dec 18 12:02:35 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paolo Bonzini X-Patchwork-Id: 181993 Delivered-To: patch@linaro.org Received: by 2002:a92:3001:0:0:0:0:0 with SMTP id x1csp605942ile; Wed, 18 Dec 2019 04:52:02 -0800 (PST) X-Google-Smtp-Source: APXvYqx/lXfVVDzOyPLi08Gce0YoldXHSt4KE4zp77aLdAY0ptsDddoxMjRNSd9IU19Upnmr+NT/ X-Received: by 2002:a0c:eacb:: with SMTP id y11mr2111874qvp.68.1576673522127; Wed, 18 Dec 2019 04:52:02 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1576673522; cv=none; d=google.com; s=arc-20160816; b=QPWuG4yYpD+bGBmve7INQ+wUxNIAMsqorK/rO/F0eDjIdOEel5ukU/ouwUvuJXsaHx e+z7VOO1qkrW69RdZ3IrOBHdmGwqE/BMTFOcu2EaWoQSshUCX5ZN4ztgWC6YzDlNqZ4u CyIWdpeO5NqTfODYxdJ0HrsaVqkowS88QMY/xVczsXDO/G+JiTUeX4dzuEVbcU30aRZ+ VuQHv4IpUvUgRHxAcKr9jNruhsvBG7Ae8VV24Xv0jJC5pydkT7TQh3MIwOZDWwNKlkxm r6ijuSAJvIGmeOpZ1D04kLyCzel3G3kH5thAlluQzTfuxkVhTzoiuam3oRcBFFpK/91G 3+Fw== 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:references:in-reply-to :message-id:date:subject:to:from:dkim-signature; bh=0RravkZg4GJs8al28mPtQXZKMfdxgs/SErQE/3uoU0E=; b=kJWqayA+FAfB2RSGEEGH3geM+kWeYxhFgx+pfD0TRnSFM/4ihJoNyPNlRrkjVJ1jxo c/4oOto8k2xBVhNcF/1vOq4miilY/pIQkZUTrvRcqK5y9WsOFteonrKDnwlylRf2GXAh NWiSw2lDef7Ehnsc1OIi8yetKYz8NWEgSf1S+T6JUQFprnVgV6AwavS8I7A2PgBBayys ASRwi5emBVEGYNImbycVr6kjLFiLlNAzDKAiPgkm6IyCaP5RXSFnMxKKCQNHiK/PaXpt sG+63I+/2xUS7m2INl12TBnUj9W5/mkryOCX6YIHHWqTB8SAhsIT4m9fbFHOW1OQ8lnx sOug== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@gmail.com header.s=20161025 header.b=bSaeIsvZ; 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=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id c4si1508508qkm.163.2019.12.18.04.52.02 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Wed, 18 Dec 2019 04:52:02 -0800 (PST) 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=@gmail.com header.s=20161025 header.b=bSaeIsvZ; 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=redhat.com Received: from localhost ([::1]:53760 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ihYo5-0006Bz-4K for patch@linaro.org; Wed, 18 Dec 2019 07:52:01 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:56311) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ihY3s-0007Jz-0L for qemu-devel@nongnu.org; Wed, 18 Dec 2019 07:04:17 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ihY3p-0003Kj-Nc for qemu-devel@nongnu.org; Wed, 18 Dec 2019 07:04:15 -0500 Received: from mail-wr1-x432.google.com ([2a00:1450:4864:20::432]:33369) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ihY3p-0003GE-Bg for qemu-devel@nongnu.org; Wed, 18 Dec 2019 07:04:13 -0500 Received: by mail-wr1-x432.google.com with SMTP id b6so2032556wrq.0 for ; Wed, 18 Dec 2019 04:04:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references; bh=0RravkZg4GJs8al28mPtQXZKMfdxgs/SErQE/3uoU0E=; b=bSaeIsvZJdjx874TaEqBWWL/9Y8tw0cc0u6FXF8Ee+pY6FvPkG1GU7Ia0hyR8oA+WX EmRAFioB0+alCZz6UvtgGRIgP2hiqXAfDPDLw5U8MIcPEWJ/ZKOi9Fi9ZYOX6EEODa9n SWxQffs3P8tnRFrfaj0685/XAcHQZ9WyC5Ge/u7oZtySWhQMnRklegn5cYRtDfRJBsge e9JbYQGl6dGU3WcA+Hf4NywdM9qMIUWf+fBJrP0x6Voqyo7TwWjEe05bI/ZhGIotFlDA gxr3mQFFFgDbTcnIMJY0tRHscY8WB1xLh6L/ZME2C6yzwM1kobqq5p7hGlFUstiP8ag5 fSzA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references; bh=0RravkZg4GJs8al28mPtQXZKMfdxgs/SErQE/3uoU0E=; b=N6s+ty/Ek0ihCF+KJS+AUhc+w8yxUZXi5Yf/0SvSew4jsevmoY2/3n7ceV8TyUxe+S Wcz+MpIrZLYBvJOadraLE54jsQ1TjAN8RzfBwA3jTLBpLkm43iDU6AbbMizhZ5glLqog c7+jA1BQBlbYM4swDhCqvdrwahV+FuU5w/YuO6g/0gLJhwYaEB5k8Cxh7LSNq2KEEsst XbW10uP4JTBOEl/gnohtZQN6gVHsk8Ex4+y/NI5LYi6GjWtAdNCDW9ArwvsEdxJx/2/f 65W21NKGOKF1H2q4raBb0l2rg2xuit1KBgINccjX2op2H5X7Do6n3+JAPYgLh99MA58h 0yLA== X-Gm-Message-State: APjAAAXen0yobGVgf+EuxBeUjLRfVg7nqhbEnMUFoLnxaW0eIp/sLtBI /hzVZD7KA/UyGM7t+hYycTOUj5yp X-Received: by 2002:adf:e984:: with SMTP id h4mr2384917wrm.275.1576670652036; Wed, 18 Dec 2019 04:04:12 -0800 (PST) Received: from 640k.lan ([93.56.166.5]) by smtp.gmail.com with ESMTPSA id n67sm2236838wmf.46.2019.12.18.04.04.10 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 18 Dec 2019 04:04:11 -0800 (PST) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PULL 69/87] docs: Create bitops.rst as example of kernel-docs Date: Wed, 18 Dec 2019 13:02:35 +0100 Message-Id: <1576670573-48048-70-git-send-email-pbonzini@redhat.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1576670573-48048-1-git-send-email-pbonzini@redhat.com> References: <1576670573-48048-1-git-send-email-pbonzini@redhat.com> X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::432 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: Peter Maydell Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" From: Peter Maydell Create a bitops.rst which is just a container for the kernel-doc comments in qemu/bitops.h. This is mostly a test of the kernel-doc extension machinery. Signed-off-by: Peter Maydell Message-Id: <20190521122519.12573-7-peter.maydell@linaro.org> Signed-off-by: Paolo Bonzini --- docs/devel/bitops.rst | 8 ++++++++ docs/devel/index.rst | 1 + 2 files changed, 9 insertions(+) create mode 100644 docs/devel/bitops.rst -- 1.8.3.1 diff --git a/docs/devel/bitops.rst b/docs/devel/bitops.rst new file mode 100644 index 0000000..6addaec --- /dev/null +++ b/docs/devel/bitops.rst @@ -0,0 +1,8 @@ +================== +Bitwise operations +================== + +The header ``qemu/bitops.h`` provides utility functions for +performing bitwise operations. + +.. kernel-doc:: include/qemu/bitops.h diff --git a/docs/devel/index.rst b/docs/devel/index.rst index c86a3cd..ac86215 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -23,3 +23,4 @@ Contents: secure-coding-practices tcg tcg-plugins + bitops