| Message ID | 20190521122519.12573-7-peter.maydell@linaro.org |
|---|---|
| State | Superseded |
| Headers | show
Delivered-To: patch@linaro.org Received: by 2002:a92:9e1a:0:0:0:0:0 with SMTP id q26csp1548075ili; Tue, 21 May 2019 05:37:08 -0700 (PDT) X-Google-Smtp-Source: APXvYqxCVR8cYmhb+6ccjFYTVU8kIO1Uigvpo6BwGyBJiTexcVMVlyhGSIWZOeWY8IxRT8FC4TQs X-Received: by 2002:a50:84e1:: with SMTP id 88mr81975732edq.193.1558442228091; Tue, 21 May 2019 05:37:08 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1558442228; cv=none; d=google.com; s=arc-20160816; b=ETG4ZQnxIAnU7hop1V/AoZSEeDvRzWI8uJ6HlfYthTIeSqScBOgZOi98aYtY6a7daB T+2Uq2SJXQiDA5pVR7zkKEBfkxRS9tGo4d1Jubqm6orxZ7iI7tv3NYB1+6dFd0zaiFlM kH9FeYppg4zjjT9228jKD09Sg0iWPeLlxlhgqkGBECqoSGerICsRdsMZZYBuPmNmq/1c JQY1FcR4l8UOlDnIL16plk4WGxCyouCEwlOrA6SJbCwhe/AfwHwepxI77xqxm2Z4ONFY UUI08UxsWXDK/z/+0W+69bYDM5H2gUkmj0ywLW96MpZ1PKa63OPjRnTvMx4c/TdCofhK JKPQ== 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=uepm/tgVGvk2ZbI1+hCKv4c6WBeYrsTqZ1hQF2HFmEo=; b=K2+4ahqLTYvcKqBwwqqBy8/wEMycatsbNXulUxFhux2nS/D1ZzEbxzv/AoLkxHkIvt QcFCNCVoci+vynZfQW4rnYC1HGaeKIr5xbWw3CFcHWtKIsiKYwJjC1ocmQ05c69f1n/5 hHrgwO16VPXraqxEbQaMX+wLJEhcWdPQo3gMg875n9zWnGxDbOiYcoF19vMsA5ZcOnSI 9F49jjkKjyj/SVgUEWBcQMb9Y/DZh4KYZM/aa2cCuhFC+GEAJiFcuAUPXGzT/U8VD/0j k9MTb6LFuAlrU7Rn85XiXAyi9kjpkVGDAqeHcyZzRwsuJAfDr90y6wzkV0l9znkWMVRt hQog== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=vnEU13DR; 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: <qemu-devel-bounces+patch=linaro.org@nongnu.org> Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id n1si2625830edd.205.2019.05.21.05.37.07 for <patch@linaro.org> (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 21 May 2019 05:37:08 -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=vnEU13DR; 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]:52883 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from <qemu-devel-bounces+patch=linaro.org@nongnu.org>) id 1hT40x-0001xC-55 for patch@linaro.org; Tue, 21 May 2019 08:37:07 -0400 Received: from eggs.gnu.org ([209.51.188.92]:45401) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from <peter.maydell@linaro.org>) id 1hT3q4-0001U6-Mm for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:53 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from <peter.maydell@linaro.org>) id 1hT3pw-0005G3-Vd for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:51 -0400 Received: from mail-wr1-x441.google.com ([2a00:1450:4864:20::441]:37548) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from <peter.maydell@linaro.org>) id 1hT3pw-00057w-N0 for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:44 -0400 Received: by mail-wr1-x441.google.com with SMTP id e15so18403506wrs.4 for <qemu-devel@nongnu.org>; Tue, 21 May 2019 05:25:32 -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=uepm/tgVGvk2ZbI1+hCKv4c6WBeYrsTqZ1hQF2HFmEo=; b=vnEU13DRzO/+QhfrSenmnXb8vqzq/j7ubcYC+eMNcXj/H/niDAgNMIUlGxiPPxTbeN bnEgqupVUJwa+6kGz1SbC+5Ee73bhFI0p9XGn+wxTkbkFuqwqa1OxKjwBU+WoFemRoSY UQi89+fVxc3XaiS027YOk02WQhJWLYp/RCfcXYKDjoEs5R86guZgD2hvyn8aaUaiH/GW 4mT4goHvHEYij6D+eM2kj9hO/2ocPw1t9lxVHuPaCHXUa93ZQu/ogJeUQ0dtwqkLtlJM jSXltd5Py0V4PSpqc7es/KeZ39PIvUkWPULR7DT/BzAjBAlHC9dwEyP6k6t8LsOZn0ct 7pmw== 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=uepm/tgVGvk2ZbI1+hCKv4c6WBeYrsTqZ1hQF2HFmEo=; b=RYAmVjdcvopr4H5dC0nVY/JB9FhZV9UyrOVPiT1qBRdCvAX36KWBfWPVTs1ZIu+dN3 3M4kyPDns4vxyMSUwp+lqqz0HDvj4jWuOOLp3IMVSpYW3OYXxJ/fjAGcGeU8Ky2xnXRb l5fdiE1ZuAP2BhNsgv8kxoVT504xzW6ZVRh1GZNMVXJkbdKoDhret4V7S18gPyFDvBts YTLXtglWs/X2S0wAgybboL3A7B0Y2ObAa9cAYobu7z/6alYpjzfDBWMgzZeXiWg1Dcr4 84qbJpPi19UkkMOLLuVBzXs9krfzDUUrHfuFVfSpAb6pslHMSwJAS8r3u+QNEdokKtTe MWzg== X-Gm-Message-State: APjAAAWNNSH108M/zAr8tTvswlR/Bn0B60Zdh8X5D88FaIKztEfYpVVk XXFUxekkAaT2w2o9NM1BrGXLmNqJpwA= X-Received: by 2002:a5d:55c9:: with SMTP id i9mr985311wrw.261.1558441531476; Tue, 21 May 2019 05:25:31 -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.30 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 21 May 2019 05:25:30 -0700 (PDT) From: Peter Maydell <peter.maydell@linaro.org> To: qemu-devel@nongnu.org Date: Tue, 21 May 2019 13:25:15 +0100 Message-Id: <20190521122519.12573-7-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 Content-Transfer-Encoding: 8bit X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::441 Subject: [Qemu-devel] [RFC 06/10] docs: Create bitops.rst as example of kernel-docs X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: <qemu-devel.nongnu.org> List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>, <mailto:qemu-devel-request@nongnu.org?subject=unsubscribe> List-Archive: <http://lists.nongnu.org/archive/html/qemu-devel/> List-Post: <mailto:qemu-devel@nongnu.org> List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help> List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>, <mailto:qemu-devel-request@nongnu.org?subject=subscribe> Cc: "Daniel P. Berrange" <berrange@redhat.com>, Eduardo Habkost <ehabkost@redhat.com>, Gabriel Barreto <sbarreto.gabriel@gmail.com>, "Emilio G. Cota" <cota@braap.org>, Stefan Hajnoczi <stefanha@redhat.com>, Cleber Rosa <crosa@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, John Snow <jsnow@redhat.com> Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" <qemu-devel-bounces+patch=linaro.org@nongnu.org> |
| Series |
Add kernel-doc support to our Sphinx setup
|
expand
|
diff --git a/docs/devel/bitops.rst b/docs/devel/bitops.rst new file mode 100644 index 00000000000..6addaecf8d7 --- /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 2a4ddf40ad3..49cb212a8b4 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -21,3 +21,4 @@ Contents: testing decodetree secure-coding-practices + bitops
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 <peter.maydell@linaro.org> --- docs/devel/bitops.rst | 8 ++++++++ docs/devel/index.rst | 1 + 2 files changed, 9 insertions(+) create mode 100644 docs/devel/bitops.rst -- 2.20.1