From patchwork Wed Dec 18 12:02:32 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paolo Bonzini X-Patchwork-Id: 181992 Delivered-To: patch@linaro.org Received: by 2002:a92:3001:0:0:0:0:0 with SMTP id x1csp587349ile; Wed, 18 Dec 2019 04:35:01 -0800 (PST) X-Google-Smtp-Source: APXvYqxEkBVFf+KayaWQyyBUnFw1yMy2TtHKwjh8knUqYjM/IxXpJuD6C/cUyZtCItZd8AYYbeVS X-Received: by 2002:a9d:7cd0:: with SMTP id r16mr2484575otn.50.1576672501447; Wed, 18 Dec 2019 04:35:01 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1576672501; cv=none; d=google.com; s=arc-20160816; b=vlHgZ9kmZAkzqwV0c4jdgzHwIcliY7ZTLrt3a107l+gEZxE66grJsRR3pFGEn2Nxwa QExBowDpiYrylbafYsMbS5S62l6wG1spP7vjGOKAHgZmJ5id3qsVfwxqsGNJJZN6dJ9b kkzND7gKJ2+Tx0FfyuNyBwwmmQMPGtIGx9KRn3DV8OVdFQcRgJKFdZq1WTzy7ZFC41Bs 6fJEISgVXyYdP5oGqGBEQZIFuX2zI+t2VT7rI7cmFh6epzBkTNqNyXIpUvHiZrbtsecw k3ra25klBR1xf9Gm1KZblf1haemfmRMUhQXfr/zrx64l6PPFjeJLwWDMykIvmSSXweVv wdlQ== 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=uGE6rR1IJJ9r/VKOprUnSz1PtFT2C2MrjAAe7zPzb4Q=; b=CHXkX8r1QHQulb8Gom9z5+/c8w8wpTey44guF5/QbMOtIyAdoGglplaS3xchjZd8bC QsNNUWyW2JitMmUtnm0Kyg4omtahKiuYrf0H+bgIa1rRo3wagNfuCkuwjK63dwJSOOis WgSHUu+cEum2E1hcQ4iPvn/8Eu8x51lb55zLu6h3Z6oGdbvBC0D1/XTHWh1pxY7QUfEa FGDBlRnK0+ygXc/p9ssGKQRztIMDmJhTyPdUtdyY3PpddN+xA3+lfVhxgPihIkhMEChJ PviyltUezyEBIS5iEp9ze9kkqGwvgILxP3Tk2Tod5AX4xqv2EhuOhVr29Q9Sw+Zl0IS/ /XEg== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@gmail.com header.s=20161025 header.b=iS90RVAv; 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 185si1231278oie.52.2019.12.18.04.35.01 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Wed, 18 Dec 2019 04:35:01 -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=iS90RVAv; 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]:53547 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ihYXc-0007yo-8m for patch@linaro.org; Wed, 18 Dec 2019 07:35:00 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:55743) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ihY3o-0007Fm-OU for qemu-devel@nongnu.org; Wed, 18 Dec 2019 07:04:13 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ihY3m-00038J-J0 for qemu-devel@nongnu.org; Wed, 18 Dec 2019 07:04:11 -0500 Received: from mail-wm1-x331.google.com ([2a00:1450:4864:20::331]:55126) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ihY3m-00034S-Bw for qemu-devel@nongnu.org; Wed, 18 Dec 2019 07:04:10 -0500 Received: by mail-wm1-x331.google.com with SMTP id b19so1554986wmj.4 for ; Wed, 18 Dec 2019 04:04:10 -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=uGE6rR1IJJ9r/VKOprUnSz1PtFT2C2MrjAAe7zPzb4Q=; b=iS90RVAv5i5quMQlaS/MzeNOfPVYMasCfz6tWH9PE7j+cHYtkiYtH9WDC7ImeL9MpE g4cs9OyVIZxs2Bp/vdz7LM0khhTZU4zJuJgbbknoK9EWuDxc8mfjHWeJkY3bYGLU3BQM gVSf8ORmVcuwIcdQVUkz7T47o/rNqVyx9zzprblgU2lMOF7GWhMUoCBWAKRLJbO4eyfT +uHdbHqznKNBO5LQGoPYqAsY/FFecaia/GxpD04Vu7ZwPKe9KQS3R4q7oxCXFdtLwWdi pwjAXJklZvCPDCHKzg6fOrRxTovHqC0OafJVWwpmJDEtT+eGlxUsTe5hUASjhLvzvRl/ tKEg== 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=uGE6rR1IJJ9r/VKOprUnSz1PtFT2C2MrjAAe7zPzb4Q=; b=ltR8H83DL4ZZC2DOg90hfArDlTzs3O7i6PQp5590jc3bWYYRsJEUzhh3cfxcTZvQdt 2nbVVz/uM4jgqQqUtzphNRsLO5bvuFf3qI+7LchuWb/tBTbJ3PD3o++QQlo09qvv/7pP I46pigzKIUzAU+7jGirCtorCnjYjlRIuNREKQbAgD4aUzDhh2Bg0tmsEgf+miKqCgRdk 9ZDLw8sovd7WXVOkt4hhF8wKcmX2iYLTspKsgYv+c59Hzmu4/kYEqSqgJkuhg8ncfGef RnIVfC71KbWvr0j6IWadxPHVboQPBf+zZ/Abk/ZLS0xnRu7HZBDememNR5m6S8QqAIVA 60FA== X-Gm-Message-State: APjAAAXkokJ7BeCSIQQUZKWJXxW7x3HvAEAIu2kErwjbUosvXplvI+g2 DLjWjgZZXNAwsAvyKPl+JawJ2wjV X-Received: by 2002:a1c:9602:: with SMTP id y2mr2831196wmd.23.1576670649194; Wed, 18 Dec 2019 04:04:09 -0800 (PST) Received: from 640k.lan ([93.56.166.5]) by smtp.gmail.com with ESMTPSA id n67sm2236838wmf.46.2019.12.18.04.04.08 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 18 Dec 2019 04:04:08 -0800 (PST) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PULL 66/87] docs/conf.py: Enable use of kerneldoc sphinx extension Date: Wed, 18 Dec 2019 13:02:32 +0100 Message-Id: <1576670573-48048-67-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::331 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 Signed-off-by: Peter Maydell Message-Id: <20190521122519.12573-4-peter.maydell@linaro.org> Signed-off-by: Paolo Bonzini --- docs/conf.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) -- 1.8.3.1 diff --git a/docs/conf.py b/docs/conf.py index b7edb06..259c604 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -54,7 +54,7 @@ needs_sphinx = '1.3' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['qmp_lexer'] +extensions = ['kerneldoc', 'qmp_lexer'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -216,3 +216,8 @@ texinfo_documents = [ +# We use paths starting from qemu_docdir here so that you can run +# sphinx-build from anywhere and the kerneldoc extension can still +# find everything. +kerneldoc_bin = os.path.join(qemu_docdir, '../scripts/kernel-doc') +kerneldoc_srctree = os.path.join(qemu_docdir, '..') From patchwork Wed Dec 18 12:02:33 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paolo Bonzini X-Patchwork-Id: 181995 Delivered-To: patch@linaro.org Received: by 2002:a92:3001:0:0:0:0:0 with SMTP id x1csp610767ile; Wed, 18 Dec 2019 04:56:35 -0800 (PST) X-Google-Smtp-Source: APXvYqxvmOjEeRg4p8ddvnjHrS53l4Rh9DPd1Q3jCt89VVWZj1dP1Y4mm78eNXjtVdyFyNtO4/L2 X-Received: by 2002:ae9:f009:: with SMTP id l9mr2257853qkg.259.1576673795424; Wed, 18 Dec 2019 04:56:35 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1576673795; cv=none; d=google.com; s=arc-20160816; b=KPHZZi0jWg6Xzh+pWq31FiAKucCfRZEjt40bRKSJe8T/zWVSu2kRmC5jz4DTaxavwH VaMEpFtBh80cF9lXtTdKY9AHsZSxku51lIqvu0DCQ40bmpAxCtftlimDFdVyYMPISFka eHcQNidA8M0vWPAmiNaJ3eG6GJ90o2rgM1eQOx9pbeDssEPaQE/4itcdH1pB5dC+NM36 oVy6LzkdC0odRX+MVIj0otEVJZ4T5P78u19PSYrogqbe1949b7QQ6Qs2PzwsifjbFG8u wX0g5wN7xaqM8HQ6doiB/DykufJ8C6asLo936Nc+Q6+Sa3mbt+yAX3ZaV2r1qOeEG/jR o5tA== 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=hQn5BCLt9ly+0ISKdp5mviL+DCI+GuaIKgSx0WHQgTU=; b=UIs9BmPBoHqP8gJYjgEezAklMeVB+C0tNLOrirPFOi0i4Pe7CzspgQYg6pE+yRcNWa CnRK5LUkR2fgPBbFw31lPJwxLuAo27fqScc21CQ4gjPxwvl0zDaisOak/d6xGKz/q/nP MSlXOHFnslKclPLZgGuNV4sTs2wWUguXlHPzbNGQHVUJQ+ruPlN9CaV9Ec/mdU8+RHtK QPqLBkZzfEuTClEzbhcEZi4e9+BsYH0Q4bbTZDdc1Img/kq1b0j+7LiX45xXWIBC6xJm ygbKc7zYgCJE1uh4r4wXKJ9z5FS7pZ0KB8Nyv7vC221x3kIJXewUAfvbRISd5dofAB56 GAUw== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@gmail.com header.s=20161025 header.b=rc1uwZpR; 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 l90si1111322qtd.153.2019.12.18.04.56.35 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Wed, 18 Dec 2019 04:56:35 -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=rc1uwZpR; 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]:53822 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ihYsU-0004Df-NW for patch@linaro.org; Wed, 18 Dec 2019 07:56:34 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:55785) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ihY3p-0007Fu-2E for qemu-devel@nongnu.org; Wed, 18 Dec 2019 07:04:14 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ihY3n-0003C6-Jo for qemu-devel@nongnu.org; Wed, 18 Dec 2019 07:04:12 -0500 Received: from mail-wm1-x336.google.com ([2a00:1450:4864:20::336]:53453) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ihY3n-00038q-Aq for qemu-devel@nongnu.org; Wed, 18 Dec 2019 07:04:11 -0500 Received: by mail-wm1-x336.google.com with SMTP id m24so1554742wmc.3 for ; Wed, 18 Dec 2019 04:04:11 -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=hQn5BCLt9ly+0ISKdp5mviL+DCI+GuaIKgSx0WHQgTU=; b=rc1uwZpRhdqIDpd+HUK9tFWpL2f4o2J0ob2s0kE8re2YXkm3T2Lm3dJYzq4g7ySjwu yNRKpjSOlX9LyojW/9sPASj9rcaYvGG7A0D8qgRWOYgAw8fg1XbLggtvm85IJLjuwis8 h+4Y4lodne7cp8CT7jChkezTKyVMoFmZE/enBy0+ffsmCVTqY5PAHesPHBHa6YuUBuxJ 3c9Gayf6bI7HT5cTs/cPno/3YW33sV1Fjo3R1T4VsZS6SwxnNN939wZKeJjI9WtQz6UX vIHHd8uNUa4iI0d9Ifp9FEVEKQIrjhv2WZwMmP5qQA3Bp07mu2GgLJr3eevqEAiMxnzC BxUQ== 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=hQn5BCLt9ly+0ISKdp5mviL+DCI+GuaIKgSx0WHQgTU=; b=t6gm+b9FPrh4TLXDOhsVpN3UtT/bcS/LAoxQTPQmkOXsJSdzV9AB75zUUSS4tC9Mee 6kymccL95gQYogdKUyzLj98vhvEi6CasjyVLwSfcSgHw0zX4oDm+Mm0mJQ8vZ4NhE4s5 QjmFtIwNugdnlJpJ7NQw2qZYO9Bd+RdWSztIEOJbbeQTEoeBZGil/HrO808kkqYYtMOH XuiENI5ox4cwx9yj2ayzj/qrjHWcdHVNLhi8wvR+Ye79OpxB3h/6l97+Kku24hLAMGv8 4/vdQ5mxbzkBSn5kFdLOf76DQlf27vqLBTF4c3OIPjvKRX+4xBQge3HuZ5oWarESxw4u q45A== X-Gm-Message-State: APjAAAVNBmPbHMRsQ8Hr+0FofxYK0dPp9W5lQ79ZGnJTP9YYpl1rhzW7 GuM0vBS9zdUid9ZSGNZrder+2py3 X-Received: by 2002:a7b:c93a:: with SMTP id h26mr2798903wml.83.1576670650020; Wed, 18 Dec 2019 04:04:10 -0800 (PST) Received: from 640k.lan ([93.56.166.5]) by smtp.gmail.com with ESMTPSA id n67sm2236838wmf.46.2019.12.18.04.04.09 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 18 Dec 2019 04:04:09 -0800 (PST) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PULL 67/87] Makefile: disable Sphinx nitpicking Date: Wed, 18 Dec 2019 13:02:33 +0100 Message-Id: <1576670573-48048-68-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::336 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 Turn off Sphinx nitpicking as a temporary (?) measure so sphinx builds complete even with warnings about missing references. Signed-off-by: Peter Maydell Message-Id: <20190521122519.12573-11-peter.maydell@linaro.org> Signed-off-by: Paolo Bonzini --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) -- 1.8.3.1 diff --git a/Makefile b/Makefile index 531e955..6b5ad11 100644 --- a/Makefile +++ b/Makefile @@ -1001,7 +1001,7 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop/index # Note the use of different doctree for each (manual, builder) tuple; # this works around Sphinx not handling parallel invocation on # a single doctree: https://github.com/sphinx-doc/sphinx/issues/2946 -build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" sphinx-build $(if $(V),,-q) -W -n -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1") +build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" sphinx-build $(if $(V),,-q) -W -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1") # We assume all RST files in the manual's directory are used in it manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst) $(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py From patchwork Wed Dec 18 12:02:34 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paolo Bonzini X-Patchwork-Id: 181994 Delivered-To: patch@linaro.org Received: by 2002:a92:3001:0:0:0:0:0 with SMTP id x1csp608950ile; Wed, 18 Dec 2019 04:54:51 -0800 (PST) X-Google-Smtp-Source: APXvYqzU9EjWqCHcEMjxSyLMTfcypoVwu5e+J7pn4ARkQpCJZzZZR2su8ByQWyQk7Vipe88cgfT7 X-Received: by 2002:a05:6214:301:: with SMTP id i1mr1391620qvu.244.1576673691153; Wed, 18 Dec 2019 04:54:51 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1576673691; cv=none; d=google.com; s=arc-20160816; b=EJmUWDnOQRWaN6eu59bogTaK1lHwGZqdKTbnPXsajQo+X2wP7u5dBHszBE8t280g+U V96YGHinN0RNTwRi6FtG6ogHBiMCKTE1KrLJwolURRi8Sj4ux2HDFcbe8hfo/oyDigZ7 6JqMSA/ImN5q20ZdnRrn0P65u0b3kthc8FwsbQm7q2SKVCHtgcpX4kKj+R+ZCdD6eDyn 0JaUJsS1idr8aNkrO4qMh0EstZL0xtqzeweHhNrJkFcvjRKTQkq8El/AKngYRADtfWWh dS3A8iHxn7vJVnbahdhLoEFiWt3zZ+c56+0q9tdeX3xvXahs6qH3iFuGARcioMOrPutw RFew== 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=vTtE2quRQYcYlfKRpBZjr5cgNUsYu4H3G5CXjyyh7e0=; b=EwadjhZ/tCJcWPVeyyy5sS6Ng+oWYnvBbQ4wzKAFjS2mtJQyZJGPUf4U4Xi1xThBlE wnAl2R5ctj8NIZcTpCl+luCOpmqLjDYE4a+v3DhoQ+352qEuYLw0qNAzuxk0e2jfJtR6 ZArrivwasM4DPhTPdJEwVj8vIZYZd1XCqV8R408D7d3bLW4F2j9yOiInKgkxSZ+dlcWU m8DZEFgQ7zZcTi9pZUIc4HcxaqMGkMZBXG18xtmXL35N79QbJCI1mSZMIOPFcrm/18Vb kQM+xm6XlNCkeuNAscv3I40+jO+fd3V4dWYChTuSqQwq2cFMkZfZXVrN4lT9+LF5MZql yPAw== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@gmail.com header.s=20161025 header.b=Du4VCRyh; 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 v15si1250499qvr.3.2019.12.18.04.54.51 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Wed, 18 Dec 2019 04:54:51 -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=Du4VCRyh; 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]:53800 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ihYqo-0001pt-AY for patch@linaro.org; Wed, 18 Dec 2019 07:54:50 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:56231) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ihY3r-0007JR-HJ for qemu-devel@nongnu.org; Wed, 18 Dec 2019 07:04:16 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ihY3p-0003KD-Jh for qemu-devel@nongnu.org; Wed, 18 Dec 2019 07:04:15 -0500 Received: from mail-wm1-x336.google.com ([2a00:1450:4864:20::336]:36362) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ihY3p-0003C7-9p for qemu-devel@nongnu.org; Wed, 18 Dec 2019 07:04:13 -0500 Received: by mail-wm1-x336.google.com with SMTP id p17so1621725wma.1 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=vTtE2quRQYcYlfKRpBZjr5cgNUsYu4H3G5CXjyyh7e0=; b=Du4VCRyhtJDAIY+Y+wKdBs50YBKdbAFO9QlO02+wvB8GZuRTIxPuMmnTpzywj689kI bMtPBriuV3NqbScGiIWPjT4PlZnEpU8aPZmAscRX+60ONaOLHuymHzQn7LqphnNT2ShR BWDc4afBgH07YJyRfPY+nMrTn9CpuIEFhQ+clCvdG18WVMUhsHiCmHFUrmyjPfjNs1p5 xROgiSII18eFvVmewRKyQU3vsEUtYyMNnSeFYT6p9eGRWLP6u+zNhw3jx39ayH57Yhob x+U8HP0/S+q+LDI/TSj2PUkEeQD5gkvcVPCgjYyyISRHchUvuHxxbgGE3x/7GL+1YVzN EtSQ== 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=vTtE2quRQYcYlfKRpBZjr5cgNUsYu4H3G5CXjyyh7e0=; b=sTC11z3+17sGZ18Oxds/+fCVUJflzBY8VgF3aJyHJwBJjUN+8MbAbz6OG+6T+VzXMD ZQccqiTGGgwQCMBRZfwu3FYzhyfoBMk5z9aGNVmIbDGH9AOiSnDlfDuVGoxDKIvIG7pg r3ZVAik9HH5/FhblBPW929LKKRaglRv6EH2MT5Bqdro5q4V2asdrgYooS257mfPnVbRr oqQhnprplTsnIc2+im7HIN4m6XRPXA/2Ew6GqKesSnni2JTpDqaw1P50Mx9XTNw8n+wB /lxX0oTE9rtyt5AbxTZ1y1OCr0EqaLQ+LcGA42YoqHQbaMLJF0TUabjDpVXIUg12G0cQ qtEw== X-Gm-Message-State: APjAAAWvUeIm1xYjp5mxAW4agR2IS4qyn6ewXHWth7HDtwP4D7qUj9so DbMyHEUrsKCTDsKH1SRpoCGWL2JP X-Received: by 2002:a1c:7d93:: with SMTP id y141mr2956081wmc.111.1576670650922; Wed, 18 Dec 2019 04:04:10 -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:10 -0800 (PST) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PULL 68/87] bitops.h: Silence kernel-doc complaints Date: Wed, 18 Dec 2019 13:02:34 +0100 Message-Id: <1576670573-48048-69-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::336 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 Fix the problems with kernel-doc/sphinx syntax in the doc comments for the shuffle and unshuffle functions: * mismatch between comment and prototype for argument name * the inline bit patterns need to be marked up so they are processed properly and rendered as monospace Signed-off-by: Peter Maydell Message-Id: <20190521122519.12573-6-peter.maydell@linaro.org> Signed-off-by: Paolo Bonzini --- include/qemu/bitops.h | 52 +++++++++++++++++++++++++++++++-------------------- 1 file changed, 32 insertions(+), 20 deletions(-) -- 1.8.3.1 diff --git a/include/qemu/bitops.h b/include/qemu/bitops.h index ee76552..02c1ce6 100644 --- a/include/qemu/bitops.h +++ b/include/qemu/bitops.h @@ -424,13 +424,16 @@ static inline uint64_t deposit64(uint64_t value, int start, int length, /** * half_shuffle32: - * @value: 32-bit value (of which only the bottom 16 bits are of interest) + * @x: 32-bit value (of which only the bottom 16 bits are of interest) + * + * Given an input value:: + * + * xxxx xxxx xxxx xxxx ABCD EFGH IJKL MNOP * - * Given an input value: - * xxxx xxxx xxxx xxxx ABCD EFGH IJKL MNOP * return the value where the bottom 16 bits are spread out into - * the odd bits in the word, and the even bits are zeroed: - * 0A0B 0C0D 0E0F 0G0H 0I0J 0K0L 0M0N 0O0P + * the odd bits in the word, and the even bits are zeroed:: + * + * 0A0B 0C0D 0E0F 0G0H 0I0J 0K0L 0M0N 0O0P * * Any bits set in the top half of the input are ignored. * @@ -450,13 +453,16 @@ static inline uint32_t half_shuffle32(uint32_t x) /** * half_shuffle64: - * @value: 64-bit value (of which only the bottom 32 bits are of interest) + * @x: 64-bit value (of which only the bottom 32 bits are of interest) + * + * Given an input value:: + * + * xxxx xxxx xxxx .... xxxx xxxx ABCD EFGH IJKL MNOP QRST UVWX YZab cdef * - * Given an input value: - * xxxx xxxx xxxx .... xxxx xxxx ABCD EFGH IJKL MNOP QRST UVWX YZab cdef * return the value where the bottom 32 bits are spread out into - * the odd bits in the word, and the even bits are zeroed: - * 0A0B 0C0D 0E0F 0G0H 0I0J 0K0L 0M0N .... 0U0V 0W0X 0Y0Z 0a0b 0c0d 0e0f + * the odd bits in the word, and the even bits are zeroed:: + * + * 0A0B 0C0D 0E0F 0G0H 0I0J 0K0L 0M0N .... 0U0V 0W0X 0Y0Z 0a0b 0c0d 0e0f * * Any bits set in the top half of the input are ignored. * @@ -477,13 +483,16 @@ static inline uint64_t half_shuffle64(uint64_t x) /** * half_unshuffle32: - * @value: 32-bit value (of which only the odd bits are of interest) + * @x: 32-bit value (of which only the odd bits are of interest) + * + * Given an input value:: + * + * xAxB xCxD xExF xGxH xIxJ xKxL xMxN xOxP * - * Given an input value: - * xAxB xCxD xExF xGxH xIxJ xKxL xMxN xOxP * return the value where all the odd bits are compressed down - * into the low half of the word, and the high half is zeroed: - * 0000 0000 0000 0000 ABCD EFGH IJKL MNOP + * into the low half of the word, and the high half is zeroed:: + * + * 0000 0000 0000 0000 ABCD EFGH IJKL MNOP * * Any even bits set in the input are ignored. * @@ -504,13 +513,16 @@ static inline uint32_t half_unshuffle32(uint32_t x) /** * half_unshuffle64: - * @value: 64-bit value (of which only the odd bits are of interest) + * @x: 64-bit value (of which only the odd bits are of interest) + * + * Given an input value:: + * + * xAxB xCxD xExF xGxH xIxJ xKxL xMxN .... xUxV xWxX xYxZ xaxb xcxd xexf * - * Given an input value: - * xAxB xCxD xExF xGxH xIxJ xKxL xMxN .... xUxV xWxX xYxZ xaxb xcxd xexf * return the value where all the odd bits are compressed down - * into the low half of the word, and the high half is zeroed: - * 0000 0000 0000 .... 0000 0000 ABCD EFGH IJKL MNOP QRST UVWX YZab cdef + * into the low half of the word, and the high half is zeroed:: + * + * 0000 0000 0000 .... 0000 0000 ABCD EFGH IJKL MNOP QRST UVWX YZab cdef * * Any even bits set in the input are ignored. * 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