From patchwork Fri Nov 29 14:02:12 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paolo Bonzini X-Patchwork-Id: 180484 Delivered-To: patch@linaro.org Received: by 2002:a92:3001:0:0:0:0:0 with SMTP id x1csp1601300ile; Fri, 29 Nov 2019 06:03:22 -0800 (PST) X-Google-Smtp-Source: APXvYqzKO3jYPmjgLTnzpPx292cQt0M/lsMB6IX4sfooSK2OTupF8yK9qkukD7YtuxDXIiVYvF4O X-Received: by 2002:ae9:c30e:: with SMTP id n14mr16130675qkg.24.1575036201983; Fri, 29 Nov 2019 06:03:21 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1575036201; cv=none; d=google.com; s=arc-20160816; b=Xpp5oG1yz3MFe1P5hitnnGCTCyzwRfZmlrkxZiERmFSdofo7kw9t6CJOByCViXRYil m8EEAaXXjKo6G/Mdq/I5xugXEre26Oeeftql9T4C2qgb41VxceeHWEFlgr4oP0uENVIA xIaUuopRU25c9zTXUboRKhLiBG1CFyAB7Cx8+0tTvPcxUPrE8e0ztFm2PQH2/9iFJqVy VvCxhSqX4K/gh6BCS7tTNKvQPnuzGScsZ6tnp/Gww+Jc3CGAePl6kDP4uaNE2e1huvRf YoJ8QCybc4MLghhzijHLc2Y2T3M6Wkq+IJcUB6XIhe7Y+Hbi7ALmFe8Dr0zntc08rtWj 2igQ== 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:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:to:from :dkim-signature; bh=Bl/q66EQnB/Vpv+0jM7P6EssXQ6U7FEXGyqS8D7LPwk=; b=W36OowuZOYogKwTELryPj5lPmLr/G3K+HqQ8PRv6iI/2xlumYpJN5U+5G0wEFyAL+p epTVD6WWARzIOgTmb1Ri4KlZKpt6Mr8PI/NcNa9jkm+f+jQi9hqa2lKVuNEhwu4JM3ys c8y8gzyrAg7mJIEKm8l+Ujm3uYdBU0HyLxfVq8EcMlRFmYlHt23jXzaEBM5UTpn2GJY7 D2If0O485iNNUniNxADYcWCsUqbXN+uKrvHRJI9dU1Kp/ZWJvD0mAyenGP+R9AbyfnH8 8eUCN1akgm/1L4rJYAPkozytO26vvFMhEgPOFgYB8i6Z2kFP37v5/obQHOkHT4lWuCrD qlcA== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@gmail.com header.s=20161025 header.b=n2sU53h1; 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 b19si5646694qtq.190.2019.11.29.06.03.21 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 29 Nov 2019 06:03:21 -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=n2sU53h1; 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]:59488 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iagrg-0002GI-AG for patch@linaro.org; Fri, 29 Nov 2019 09:03:20 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:37121) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iagqt-00028G-EU for qemu-devel@nongnu.org; Fri, 29 Nov 2019 09:02:33 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iagqn-0003NB-75 for qemu-devel@nongnu.org; Fri, 29 Nov 2019 09:02:31 -0500 Received: from mail-wr1-x434.google.com ([2a00:1450:4864:20::434]:39942) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iagqm-0003I2-UZ for qemu-devel@nongnu.org; Fri, 29 Nov 2019 09:02:25 -0500 Received: by mail-wr1-x434.google.com with SMTP id c14so10716892wrn.7 for ; Fri, 29 Nov 2019 06:02:23 -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 :mime-version:content-transfer-encoding; bh=Bl/q66EQnB/Vpv+0jM7P6EssXQ6U7FEXGyqS8D7LPwk=; b=n2sU53h1JPh4ueANeHRgmU8jWPm7UL0w7WWkdFZ8WFvzmpuXpGNlh5l+MIffaGR5xk HF5zPpxZW1oMvwgNRYRLuHIZow6Flsdgnp0uJ0pt7j9Of2xkHMzKN7IzVK02OoaXGgGr oixjlf1p/pKUgwtw53CILGiDFIvAg2N+WUXegg3mi5TeCyCBJ5BYF5nenOk/BfGJONu0 rQ916JbNRPLxUMViPlEo5yB+xrIAnOu/DBAmqrE0ZByl9rtm5qhQdhuHhcNXZkiStN7L HSVhuf8HcH3EQyvtnI/84b+lIvnfiAdSfQpayt60fpUpJr5vzqv+VvF9jn5Q+BbjeRa3 GYUg== 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:mime-version:content-transfer-encoding; bh=Bl/q66EQnB/Vpv+0jM7P6EssXQ6U7FEXGyqS8D7LPwk=; b=Kt67rsqJDLxZrnr9BZZMIzZBc1Zq0StqtloTfAmiN+sxngLViDd1irmIhIIntTnxNW R6ONaPGUIDvET9aVsw/vAMoxcK2q7V8P5H4LmXovyqiFHMthF9LcR5rAehtXXw5dV0VN Evu4yUTDzdohsaoDsCQXPVkW3dvBCIopdYosLH+uNFGjUvCkFiJn6z9fKGacH3N0I1Ud VJP+ZEupPPoqCkor9xRzT0YvqfYlM17nmx16usBLg3J5KaEW+otKy2gsRnXLuSDo1iz7 3xqDM7gAZ6hdvDKVPu/+btaalEUuHEJkPsEDqTcjyNVfon8tEsHTQQHZ/XzM8CBCNa8W /6TQ== X-Gm-Message-State: APjAAAUdHpzU/IyMOGaHT3M93jFCrs/YDZo3N9ADA4PYZFEm2Ux+yKWS 5m0XxrnRhjCRJR7Uamzc/K1jaQCC X-Received: by 2002:adf:db86:: with SMTP id u6mr57316160wri.318.1575036141866; Fri, 29 Nov 2019 06:02:21 -0800 (PST) Received: from donizetti.redhat.com ([2001:b07:6468:f312:56e1:adff:fed9:caf0]) by smtp.gmail.com with ESMTPSA id e7sm14190030wrp.43.2019.11.29.06.02.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Nov 2019 06:02:21 -0800 (PST) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PATCH 3/8] docs/conf.py: Enable use of kerneldoc sphinx extension Date: Fri, 29 Nov 2019 15:02:12 +0100 Message-Id: <20191129140217.17797-4-pbonzini@redhat.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191129140217.17797-1-pbonzini@redhat.com> References: <20191129140217.17797-1-pbonzini@redhat.com> 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::434 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@linaro.org 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(-) -- 2.21.0 diff --git a/docs/conf.py b/docs/conf.py index b7edb0666b..259c6049da 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 Fri Nov 29 14:02:13 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paolo Bonzini X-Patchwork-Id: 180486 Delivered-To: patch@linaro.org Received: by 2002:ac9:2f4d:0:0:0:0:0 with SMTP id c13csp8550320ocg; Fri, 29 Nov 2019 06:28:26 -0800 (PST) X-Google-Smtp-Source: APXvYqziRxjVgxsp4g4Do262AG1MSnmyp/Dj1TpODwLy7oP4CIyKjm2oUqKKnb2DB1RDVr9H6PUx X-Received: by 2002:ae9:c30e:: with SMTP id n14mr16275640qkg.24.1575037706342; Fri, 29 Nov 2019 06:28:26 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1575037706; cv=none; d=google.com; s=arc-20160816; b=Eq8BKPAb2p5GyyfQwxu3m6Kcj/F4/adPnODzVDzMumfA2Hc8AEIO0LF1L+N0aTiK5f XHKvhyiyyuSppLhhP2a5oq4EimczUAfV7YidT68Eh779f/Hpv+uovfYSG1eIhKCjRJlz qWG493ERvNtmtahJFW6jyD790slno1B4FNDpJq1SxKkH6Ms1Nag5Z260qLGBB8D1r7fo pN86E91ouauVZTsXdaxKLwgyOkdXxbGmhqIyGBGQ6wqiWVOSh1DXmY/o4mwHrfsq9kOY 9czdRmhm5hBQCTeFCdIJIqsJxtlwgd5fXOx4ACIdRp5kEG/5B25EI/KkJi1AG5i/zzuu cCgg== 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:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:to:from :dkim-signature; bh=lx6DGULeUoiZGfGxG0Zx1Ji9gkFvHa0kVzeH7vCeWUY=; b=uZbEyxhDDB3kzDoJtZyoFAIGFxNV7ebHztHl08RrJT41Ou0x6Jldik/cdorbWelYzv rzY+Os3pGKKe+cI4q/jV4hkV1t401rtLZ5J4jfq884KY2JQbaTuzq08nl0haMSwmF113 r55D0qQq6MZ0leLGpuwLeiWDL1P0wfdKZZIbfzudRRqJVWECgyfN0WY1MmRUrgFl+88+ c1/R/hi3vE3Z69SihjyFutd6gu9z+jVKTHJGm6UdgtplqJiNwsW0O3SL6R9CJbGjzSb1 PoDNk7G69D4B5LS0Z5AlaP8nsHz3/QcSAKdlaYKar8JnQpVbJg2gI6xIU/rHioP4t6gs AJGg== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@gmail.com header.s=20161025 header.b=UShhFgHg; 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 j195si14826830qke.153.2019.11.29.06.28.26 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 29 Nov 2019 06:28:26 -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=UShhFgHg; 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]:59668 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iahFw-0003b6-Tg for patch@linaro.org; Fri, 29 Nov 2019 09:28:24 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:37093) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iagqs-00023c-C8 for qemu-devel@nongnu.org; Fri, 29 Nov 2019 09:02:35 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iagqp-0003PG-AR for qemu-devel@nongnu.org; Fri, 29 Nov 2019 09:02:29 -0500 Received: from mail-wm1-x32e.google.com ([2a00:1450:4864:20::32e]:55820) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iagqn-0003KQ-WC for qemu-devel@nongnu.org; Fri, 29 Nov 2019 09:02:27 -0500 Received: by mail-wm1-x32e.google.com with SMTP id a131so9970522wme.5 for ; Fri, 29 Nov 2019 06:02:24 -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 :mime-version:content-transfer-encoding; bh=lx6DGULeUoiZGfGxG0Zx1Ji9gkFvHa0kVzeH7vCeWUY=; b=UShhFgHgj7KXd3tkLQdDvEoS53pMxysTrfFinCoHFFXVTGxzt18RDKP+ejfL3aOznk X3KxEpLftVXodMQtLkT+2Lt1TO2FlVBCUvdIfJjxWjLmnPPG7n6ciXjRhrMidz/oFHUJ 2ygckf+rr0pGuZ9AkRDyIuv9BcH64+cxLJa0zEAP64yIIA9ecD1ivytSGBPVKkPXbnMt +FMVW949mYPiQvr/awp90c636Bkf+Ol137xH30PTJP+grKhrKQjVhKfoACkT0Fwl3bOe eqRWpciXBTFl1TweGMRGa8pCyuU0WAFmt4MCUynoSKazl+7QsTG9PR+8/9XDfrr7cM6Z Rvlw== 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:mime-version:content-transfer-encoding; bh=lx6DGULeUoiZGfGxG0Zx1Ji9gkFvHa0kVzeH7vCeWUY=; b=OWOIMU9P0/B/mHvaTiLWvyZSANh1zD+PVNEGOEBTt4FzEAN/gItmWhVof6DabRDt8H OhB7nIJW6R9AkgdnnbMViZWxt88i9uugEsKOqXP+brHvLwpBC6NWko+N6PR/ZSwhVv73 oRrTo9MRe0iw7J36BaJrR9ZV64s4QTtZXAOJ6ZnjBW9vd8iNlfiBMOnYZ+ajppJcCt2h KMlpkv2xpqgUx642+qFqluWuvvNlPlLI7eJBrXuJORwBQfBIoO3hUjTDXAmqk/jaGmJK laA/PJL2alEc6SLDDBnzNvKFT9wv/U0oYLtRMCrJOJj3AZNohD8olctVZckK2Uwjhp+A GhgQ== X-Gm-Message-State: APjAAAWLy+RLUnqppILRVq5g2/AFjNTikR6gs7q8k2gQ+DAdagJt7L1n SO/nCYmbEwD8HCCwpL3oGoL6fMym X-Received: by 2002:a1c:9602:: with SMTP id y2mr14039647wmd.23.1575036142861; Fri, 29 Nov 2019 06:02:22 -0800 (PST) Received: from donizetti.redhat.com ([2001:b07:6468:f312:56e1:adff:fed9:caf0]) by smtp.gmail.com with ESMTPSA id e7sm14190030wrp.43.2019.11.29.06.02.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Nov 2019 06:02:22 -0800 (PST) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PATCH 4/8] Makefile: disable Sphinx nitpicking Date: Fri, 29 Nov 2019 15:02:13 +0100 Message-Id: <20191129140217.17797-5-pbonzini@redhat.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191129140217.17797-1-pbonzini@redhat.com> References: <20191129140217.17797-1-pbonzini@redhat.com> 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::32e 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@linaro.org 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(-) -- 2.21.0 diff --git a/Makefile b/Makefile index b437a346d7..fcf16dc4cf 100644 --- a/Makefile +++ b/Makefile @@ -1010,7 +1010,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 Fri Nov 29 14:02:14 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paolo Bonzini X-Patchwork-Id: 180487 Delivered-To: patch@linaro.org Received: by 2002:ac9:2f4d:0:0:0:0:0 with SMTP id c13csp8552191ocg; Fri, 29 Nov 2019 06:29:51 -0800 (PST) X-Google-Smtp-Source: APXvYqx78NDYiGbWCoT49o0jH1I7P7x5zMDvDgtmpF3rqbpCnvCshDH7VrvSmSsQobyZIMIr2xPg X-Received: by 2002:a17:906:4e96:: with SMTP id v22mr34951875eju.219.1575037791674; Fri, 29 Nov 2019 06:29:51 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1575037791; cv=none; d=google.com; s=arc-20160816; b=SSmWucLpmUSqTat3okRiCeUiPLSa+O1sYKeHRFjZxoGKi+5aG5S+l4hoh9a83k4vuw 0hmNUIWU4On15PV3dnz6FVqptZiy2DuJpHckZkFrUguV30JxQbz4eJcGBsS8+r+XIGx/ bKYaTk1V3AuQiYJ/838YvHZ4wlfHdLXVAN9FJD4e4ybPvFxGmqN4aqmUzQWhgidYW3ZT qCOh5l+UUpOjfYS4mjm0LQ49Mi5svSrutWBh7NZysSvzX6s7McUssRwWKBGnsqgDeGXk LuIzSai1nKHxq5sdAdKCVjawmC4W925qa32UJx6MN++VEFiadWTuQDQ0Pz6wnyXB9YZA rYrw== 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:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:to:from :dkim-signature; bh=O5ALt6XeKJY7X9PuLNRV7urYrSvgNCwCrlCEcwFrxJI=; b=RSzkQ5CBW9bkCiUBQ2vzkIjo10mMAtWsLUnatO3jyBgoUwuGaVyjsO/iP8SELrl1uT 5fuVJ3hoK+C9wNXss6qqrhH1OqdIdnJQIpIjdZ4zPSWXqdvBcvmbdoRxuQEkRcYc8h8+ tt9YtthU+G6a1qsANz6nKQ2wKPD7ZRQABEEHCiyiJDM6WpQemYB9NBlIY7SH/b8MSJTF O7x1ZkzD01v4PzbiimQIiVd9gKYaFYvzYRE0NnItj3vAAuWNwtVmdStAlO649bZ8oQAD 1mC3MjKJfNWtaKXTQS5EosxFcttGaOaYnrVTzv4okh70euZUF3Qzp9F5Hz3WTc+PMEZJ Le2A== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@gmail.com header.s=20161025 header.b=o13CjgqK; 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 f26si14411417ejc.255.2019.11.29.06.29.51 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 29 Nov 2019 06:29: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=o13CjgqK; 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]:59670 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iahHI-0003tF-BY for patch@linaro.org; Fri, 29 Nov 2019 09:29:49 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:37179) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iagqu-0002Bi-Gz for qemu-devel@nongnu.org; Fri, 29 Nov 2019 09:02:41 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iagqp-0003PQ-9x for qemu-devel@nongnu.org; Fri, 29 Nov 2019 09:02:32 -0500 Received: from mail-wm1-x341.google.com ([2a00:1450:4864:20::341]:38899) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iagqo-0003Kz-4t for qemu-devel@nongnu.org; Fri, 29 Nov 2019 09:02:27 -0500 Received: by mail-wm1-x341.google.com with SMTP id p17so2333649wmi.3 for ; Fri, 29 Nov 2019 06:02:25 -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 :mime-version:content-transfer-encoding; bh=O5ALt6XeKJY7X9PuLNRV7urYrSvgNCwCrlCEcwFrxJI=; b=o13CjgqKpfljAKwquI/u7d0vnyH5XeD1OPrJYWKUaW9LqAG7QCjsbqA3RGve2Ut3yL XW8s3U1o8NBzlCJ5xKOJ9a97Qv2MIieKqwMGUuSLi2kMkIDMnTvnVlqlIVm+OlxInsP6 D64yjFHs+8zP2GFn+2ktt2Rp7+zO55osnnMJHyCk0ylOcngGOn93VWRgBCTmOBVb/kAo hE1cccBZuRXv5LLsgPHZv/6mShfn6Kn1T81gxMdbESormEI/yKi1rQQ1aMttQ3zlBWYZ 8YX4YzobftTojk0Mn/HtEQKZ94e6Pi34pI9v7CdAliGNkbMVuawUoBVV4dTb6iwhyUkh GqrA== 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:mime-version:content-transfer-encoding; bh=O5ALt6XeKJY7X9PuLNRV7urYrSvgNCwCrlCEcwFrxJI=; b=sxkXmfb9ISLfDQ0/6Nu7nxO/okxibGJ4gOK9HuZOC10LjILzSe73QBowsa9ZSc0mAn A7J5o9gR/Oglcy66flQV2eOrZvYa5uKAfyuAsj8TdngrtKF98NHL/aovF2LZFXlDWdev z5WGw6UrM+cUVKL46peBtPUV2QDw06O/yxespz7r9iabUHoN7FdZz5IUCFxreqo+yqlL OOYBmX6dZS5syCcTLiAK8MVvFCMwlSlv+zudfBBLpx9cYsxUaaEWyW8cWtW1sMFYs3t9 sIH6uR85ff3qOERSEiYiVEBLPQuoEc2M6+pbTiQe7pTsu6Vb+O3M7u7sWWkm0Urptf4/ 18uA== X-Gm-Message-State: APjAAAWNOr/7e4KcgfOSahywClkHgC13hN5XZCPciBTs5fQuQYeAE9Gx fwaqfy9Ngs59MaGJ68tsQxvrQLz2 X-Received: by 2002:a7b:c449:: with SMTP id l9mr2223764wmi.150.1575036143775; Fri, 29 Nov 2019 06:02:23 -0800 (PST) Received: from donizetti.redhat.com ([2001:b07:6468:f312:56e1:adff:fed9:caf0]) by smtp.gmail.com with ESMTPSA id e7sm14190030wrp.43.2019.11.29.06.02.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Nov 2019 06:02:23 -0800 (PST) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PATCH 5/8] bitops.h: Silence kernel-doc complaints Date: Fri, 29 Nov 2019 15:02:14 +0100 Message-Id: <20191129140217.17797-6-pbonzini@redhat.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191129140217.17797-1-pbonzini@redhat.com> References: <20191129140217.17797-1-pbonzini@redhat.com> 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::341 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@linaro.org 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(-) -- 2.21.0 diff --git a/include/qemu/bitops.h b/include/qemu/bitops.h index ee76552c06..02c1ce6a5d 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 Fri Nov 29 14:02:15 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paolo Bonzini X-Patchwork-Id: 180488 Delivered-To: patch@linaro.org Received: by 2002:a92:3001:0:0:0:0:0 with SMTP id x1csp1648255ile; Fri, 29 Nov 2019 06:35:54 -0800 (PST) X-Google-Smtp-Source: APXvYqyTwQXNJrNNk2P2ur+CMrG327x7Mq9gLlznw2Bcs7TGW2Vwve2AeHGRQVf/h92foQLwidsN X-Received: by 2002:a1c:cc01:: with SMTP id h1mr14768001wmb.172.1575038154357; Fri, 29 Nov 2019 06:35:54 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1575038154; cv=none; d=google.com; s=arc-20160816; b=SB5rS0x2wrs0RWnR9pJDCL/SoBCvUIGjJLg0iOkMs/ZIkkxLqUe81M2gL3s9Gg1gq9 IytP+RT3JeX/lN8HRet+lH7TgsZiUwKHgvM6u5fVgCvk/lsA56D32u1RFbc5LiovlCAY 62uKKwqcFtShbVj6K1PnY/EvmkwAHULOCHuEHqEMj2RwPqg1mNskW2LtCV9QgUK5icE7 CjCUxumo6LMz6wAGc7BLFVLJZRqN5n1fRAcJ0KjZHoKk+4qyOIcf8VyDQcfjWwhxQ6UW voclZO+LpCcB0TljyY/cY13fQ5/j4f+SjFQM9hvydqMBw4EJDxF1NOiFKPck+csGRZ0X HZnA== 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:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:to:from :dkim-signature; bh=7qR4CglT38h4RrB/48A3ve+rvnXStcx62AzXZuMT/HA=; b=n0/I8nFAU2H0TBztRtMyrYIML0a4Cv3/yWS2Nz5+iX+6SoxXNd1qNuRa8C/CS4C3hR QLjsGrIZl7TN+7+MyC6HuhRwsawalqeD6TgbGTkqpAD3XnrhEIq81o9qgUKYF8mDKymr XbsqXcV8cEmCetqdmYXjC2JMQ+DddZWgZmm8KotLx+VHaLgxeJIt5zqVH+JbIDUsWCwv 9NdtKo4cGnvcdcz1q63QsLf45hiA6dAbxt58GuuwSngEJIYmtyfnKNWYmadsL4NntQzE jr+T29NeuIYJNTKey+5KPepr8CAyubum0qbJRsquIWvlB7DbTLFUB9ZlPP6Yfeo1cP86 DBzg== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@gmail.com header.s=20161025 header.b="IWgM/z5f"; 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 qw23si13977931ejb.1.2019.11.29.06.35.54 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 29 Nov 2019 06:35:54 -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="IWgM/z5f"; 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]:59754 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iahNB-0000ha-7P for patch@linaro.org; Fri, 29 Nov 2019 09:35:53 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:37288) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iagqx-0002Dx-8a for qemu-devel@nongnu.org; Fri, 29 Nov 2019 09:02:37 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iagqr-0003RI-Em for qemu-devel@nongnu.org; Fri, 29 Nov 2019 09:02:34 -0500 Received: from mail-wm1-x343.google.com ([2a00:1450:4864:20::343]:37775) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iagqp-0003Nx-8B for qemu-devel@nongnu.org; Fri, 29 Nov 2019 09:02:29 -0500 Received: by mail-wm1-x343.google.com with SMTP id f129so15200845wmf.2 for ; Fri, 29 Nov 2019 06:02:26 -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 :mime-version:content-transfer-encoding; bh=7qR4CglT38h4RrB/48A3ve+rvnXStcx62AzXZuMT/HA=; b=IWgM/z5fCdtIMvwoVahfbTRwTMlIeJTZR0gvPYiYP7LVw0BrhE/bSZgEpd1FUFJmLv jkhwVjib8k6BSdqD4OvM+Vtd0hF3X0JS27m/3EFhAji1WXrycz6ZaCxjiSOOjei6reiv rLulXnVT79+DQhkYlZdkYHnH+7gcrlzvhXNJRkHazJc6V7o46PXZM9cmPU5+3w3VdvHw IDppNkcfC9Hls30dHiXenUUdUGTavnYmnhhiFEWXezfpjOvDM9wwLiHBWOOLS38QOAFb RBRB2DLcxs3Mfg/9JXVb9TwO4hujYXiJYAj2nxx2KyBSmKMMdbT+t+0tbhqZaTX9bOSQ 5kRw== 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:mime-version:content-transfer-encoding; bh=7qR4CglT38h4RrB/48A3ve+rvnXStcx62AzXZuMT/HA=; b=gEnpPVCUb5J8elNhKyBXgcdmq0l99YX3wpULnHvzTliHuUeJFYNB/TLFhZUdCF4J5k bFeZmTCLzI81SSuJssmOfkgOuiviJL3wFq/x45QUpzvSIo2AZ/EbHC9lj14eJoLszcTe fTYQ5gjoiqRkwl3N9IBYTNBM4j4ywytFuNI/d13B40ip5VRu1paXbtfYDeP7cJMcp7nu NrD6uqyfGKz1nOg8qF2PVigH8B9cJ6AK00DFWgTGOI3YFA31vlsSHCeknRPQjWc+kmiQ er8lzQ2MhiZqKjZNKdny3Tt5ZlGUzKbfnDcEPcd5bpKe5aVyXt39M+0QwgukZqER3ril NXYQ== X-Gm-Message-State: APjAAAUIJKKOfOOROwJ+qtCwYX2nv8sO0Ro1mhAY9QoLtgaaPQ0qHyYP RG3NQywC5pHJaO6KdMmNCHqB8CC9 X-Received: by 2002:a7b:c768:: with SMTP id x8mr15480299wmk.26.1575036144750; Fri, 29 Nov 2019 06:02:24 -0800 (PST) Received: from donizetti.redhat.com ([2001:b07:6468:f312:56e1:adff:fed9:caf0]) by smtp.gmail.com with ESMTPSA id e7sm14190030wrp.43.2019.11.29.06.02.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Nov 2019 06:02:24 -0800 (PST) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PATCH 6/8] docs: Create bitops.rst as example of kernel-docs Date: Fri, 29 Nov 2019 15:02:15 +0100 Message-Id: <20191129140217.17797-7-pbonzini@redhat.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191129140217.17797-1-pbonzini@redhat.com> References: <20191129140217.17797-1-pbonzini@redhat.com> 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::343 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@linaro.org 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 -- 2.21.0 diff --git a/docs/devel/bitops.rst b/docs/devel/bitops.rst new file mode 100644 index 0000000000..6addaecf8d --- /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 c86a3cdff2..ac862152dc 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -23,3 +23,4 @@ Contents: secure-coding-practices tcg tcg-plugins + bitops