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. *