From patchwork Tue May 21 12:25:15 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 10953585 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id EFB40912 for ; Tue, 21 May 2019 12:36:10 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id DF3B1289D4 for ; Tue, 21 May 2019 12:36:10 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id D33BF289F5; Tue, 21 May 2019 12:36:10 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.0 required=2.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 7D8C3289E5 for ; Tue, 21 May 2019 12:36:10 +0000 (UTC) Received: from localhost ([127.0.0.1]:52843 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hT401-0001Pw-RP for patchwork-qemu-devel@patchwork.kernel.org; Tue, 21 May 2019 08:36:09 -0400 Received: from eggs.gnu.org ([209.51.188.92]:45401) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) 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 ) 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 ) 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 ; 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-Google-Smtp-Source: APXvYqweJlDeUrjOYsija94FGi9SwtnDdp6HnxGL1nhZ60Utin63umGk8YbBKOZwdZWAIp/uyETn1w== 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 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 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: 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+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Virus-Scanned: ClamAV using ClamSMTP 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 --- docs/devel/bitops.rst | 8 ++++++++ docs/devel/index.rst | 1 + 2 files changed, 9 insertions(+) create mode 100644 docs/devel/bitops.rst 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