Message ID | 20240126-gix-mtk-warnings-v1-6-eed7865fce18@chromium.org (mailing list archive) |
---|---|
State | Accepted |
Delegated to: | Hans Verkuil |
Headers |
Received: from am.mirrors.kernel.org ([147.75.80.249]) by linuxtv.org with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from <linux-media+bounces-4241-patchwork=linuxtv.org@vger.kernel.org>) id 1rTVTu-0002UI-1t for patchwork@linuxtv.org; Fri, 26 Jan 2024 23:19:31 +0000 Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id 339DA1F25CFE for <patchwork@linuxtv.org>; Fri, 26 Jan 2024 23:19:28 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id C3F1D605D2; Fri, 26 Jan 2024 23:16:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="ZpkHrIYg" X-Original-To: linux-media@vger.kernel.org Received: from mail-qk1-f177.google.com (mail-qk1-f177.google.com [209.85.222.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id C23005C5E0 for <linux-media@vger.kernel.org>; Fri, 26 Jan 2024 23:16:12 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.222.177 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706310975; cv=none; b=HEMvKY+KEaUUWusupyu2McQJ067BMcl8d5p2CEZ512UywHO8O3N367Bi8G1dM27shxZAQlRUJn7y+4BWVBANgF0V4FAythncPZ4Ihmo/4C4IfARF6lVAwQ0MsRkZ28wJMtftEoejcwwX4h4SGnlOx4to+tOPqwpJo1aELcnJ0Xo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706310975; c=relaxed/simple; bh=uKwiWzeO0xFAMIWvpeHxHonS+sA78lVm8Pf7e/oU4ns=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=G8XikJoWq016dPeocF4BBOETtXC94tZZY2/PbiLMaiaAid1Wsk7iC4tbeht4gfSQ1zChlMAXB8PqlgUiqkSloN3xjPPgLXnB0pnqsK/Ffa1ukjS0deCQVd1eNyyI4STCyKLtHxfHdwz84W3EqLQFnHa+t/xYniDTfijjoizfDpM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=ZpkHrIYg; arc=none smtp.client-ip=209.85.222.177 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Received: by mail-qk1-f177.google.com with SMTP id af79cd13be357-783cd245ec0so73626685a.3 for <linux-media@vger.kernel.org>; Fri, 26 Jan 2024 15:16:12 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1706310971; x=1706915771; darn=vger.kernel.org; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:from:to:cc:subject:date:message-id :reply-to; bh=0dgr7uAnKOP7T5XfeX17z97swkwNkCZ42zeC6YgDi/s=; b=ZpkHrIYgvrgSSRwCjIODgfyT521vqnUhVzVOlxSw4FbJDpqdPaGv9O0Iv81ilqsOQX KoT6Wy5Elfh9UaCVc3jN4rYeM0bhQXEHscM0ws4aumCcC/S2uxTGU5xEBYnUq0SSx0uI 316FhRwj/pMp/ng4WzjalFS86CKPO8woAaUXI= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1706310971; x=1706915771; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=0dgr7uAnKOP7T5XfeX17z97swkwNkCZ42zeC6YgDi/s=; b=FpJVv6PMNj5u7yfrm3oEVG5zEvHRH/fzuN6IVIajF+h6XmHFwoHP0MRm2mquK3BayY lcR+zKoV3oWWN3tBPF5pEIn8jnnAYdGdjvIhOB24uxwCKw+hHpLIW+A3RY463Lcc6kr8 JxmZEjYGzUaWQVKNSsfqROUbokzSY4EuTYFfoeV+cS/D1KgYiguuX8a9D7q1IeMfozPK AUNgGxYfJkpjhz+Tk6jvP29xLDRKHxSz6zLnUeR60AuOWS7QK8uP5RnrSjSI36t5/6Oa v5saSUK42cqGJk5GexJuKpQeFkp5/PS5Q/WfhxpeBUBBIL/hRMWXN7yyWe7yhmEVZL1J 883A== X-Gm-Message-State: AOJu0Yy/9SKTlEYNPJlu9atEZdzqtA/gX2PmHLCA6hDypYWtKKsgwfSU gH/JY5QYyaiBOfW7p42aOU0q6IluwHl2PAXLUF2yC4lxBT0m8AnIn76uCLqxaA== X-Google-Smtp-Source: AGHT+IHsMkOc7Y1zxu9ngxPBQ4/Ve5FRbTtg/VBTpnZVoIwUFy4DQtcLLUh2LbUFnAzoTvCw0KH84Q== X-Received: by 2002:ae9:e917:0:b0:783:4dfb:11ae with SMTP id x23-20020ae9e917000000b007834dfb11aemr522337qkf.63.1706310971522; Fri, 26 Jan 2024 15:16:11 -0800 (PST) Received: from denia.c.googlers.com (240.157.150.34.bc.googleusercontent.com. [34.150.157.240]) by smtp.gmail.com with ESMTPSA id m4-20020a05620a290400b00783de3ddf5esm507358qkp.70.2024.01.26.15.16.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 26 Jan 2024 15:16:11 -0800 (PST) From: Ricardo Ribalda <ribalda@chromium.org> Date: Fri, 26 Jan 2024 23:16:05 +0000 Subject: [PATCH 06/17] media: i2c: css-quirk.h: Fix kerneldoc Precedence: bulk X-Mailing-List: linux-media@vger.kernel.org List-Id: <linux-media.vger.kernel.org> List-Subscribe: <mailto:linux-media+subscribe@vger.kernel.org> List-Unsubscribe: <mailto:linux-media+unsubscribe@vger.kernel.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20240126-gix-mtk-warnings-v1-6-eed7865fce18@chromium.org> References: <20240126-gix-mtk-warnings-v1-0-eed7865fce18@chromium.org> In-Reply-To: <20240126-gix-mtk-warnings-v1-0-eed7865fce18@chromium.org> To: Tiffany Lin <tiffany.lin@mediatek.com>, Andrew-CT Chen <andrew-ct.chen@mediatek.com>, Yunfei Dong <yunfei.dong@mediatek.com>, Mauro Carvalho Chehab <mchehab@kernel.org>, Matthias Brugger <matthias.bgg@gmail.com>, AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>, Sakari Ailus <sakari.ailus@linux.intel.com>, Laurent Pinchart <laurent.pinchart@ideasonboard.com>, Hans Verkuil <hverkuil-cisco@xs4all.nl>, Hans Verkuil <hverkuil@xs4all.nl>, Kieran Bingham <kieran.bingham@ideasonboard.com>, Bin Liu <bin.liu@mediatek.com>, Ezequiel Garcia <ezequiel@vanguardiasur.com.ar>, Philipp Zabel <p.zabel@pengutronix.de>, Stanimir Varbanov <stanimir.k.varbanov@gmail.com>, Vikash Garodia <quic_vgarodia@quicinc.com>, Bryan O'Donoghue <bryan.odonoghue@linaro.org>, Bjorn Andersson <andersson@kernel.org>, Konrad Dybcio <konrad.dybcio@linaro.org>, Sylwester Nawrocki <s.nawrocki@samsung.com>, Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>, Alim Akhtar <alim.akhtar@samsung.com>, Marek Szyprowski <m.szyprowski@samsung.com>, Andrzej Hajda <andrzej.hajda@intel.com>, Bingbu Cao <bingbu.cao@intel.com>, Tianshu Qiu <tian.shu.qiu@intel.com>, Greg Kroah-Hartman <gregkh@linuxfoundation.org>, Neil Armstrong <neil.armstrong@linaro.org>, Kevin Hilman <khilman@baylibre.com>, Jerome Brunet <jbrunet@baylibre.com>, Martin Blumenstingl <martin.blumenstingl@googlemail.com> Cc: linux-media@vger.kernel.org, linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-mediatek@lists.infradead.org, linux-rockchip@lists.infradead.org, linux-arm-msm@vger.kernel.org, linux-samsung-soc@vger.kernel.org, linux-staging@lists.linux.dev, linux-amlogic@lists.infradead.org, Ricardo Ribalda <ribalda@chromium.org> X-Mailer: b4 0.12.3 X-LSpam-Score: -4.0 (----) X-LSpam-Report: No, score=-4.0 required=5.0 tests=ARC_SIGNED=0.001,ARC_VALID=-0.1,DKIMWL_WL_HIGH=-1,DKIM_SIGNED=0.1,DKIM_VALID=-0.1,DKIM_VALID_AU=-0.1,DMARC_PASS=-0.001,HEADER_FROM_DIFFERENT_DOMAINS=0.5,MAILING_LIST_MULTI=-1,RCVD_IN_DNSWL_MED=-2.3,SPF_HELO_NONE=0.001,SPF_PASS=-0.001 autolearn=ham autolearn_force=no |
Series |
media: kerneldoc warnings
|
|
Commit Message
Ricardo Ribalda
Jan. 26, 2024, 11:16 p.m. UTC
Kerneldoc does not seem to understand that embed doc:
drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'write' description in 'ccs_quirk'
drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'reg' description in 'ccs_quirk'
drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'val' description in 'ccs_quirk'
Convert into a standard doc.
Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
---
drivers/media/i2c/ccs/ccs-quirk.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
Comments
On 1/26/24 15:16, Ricardo Ribalda wrote: > Kerneldoc does not seem to understand that embed doc: > drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'write' description in 'ccs_quirk' > drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'reg' description in 'ccs_quirk' > drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'val' description in 'ccs_quirk' > Correct. It's never tried to understand that AFAIK. > Convert into a standard doc. > > Signed-off-by: Ricardo Ribalda <ribalda@chromium.org> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > drivers/media/i2c/ccs/ccs-quirk.h | 8 ++++---- > 1 file changed, 4 insertions(+), 4 deletions(-) > > diff --git a/drivers/media/i2c/ccs/ccs-quirk.h b/drivers/media/i2c/ccs/ccs-quirk.h > index 0b1a64958d71..392c97109617 100644 > --- a/drivers/media/i2c/ccs/ccs-quirk.h > +++ b/drivers/media/i2c/ccs/ccs-quirk.h > @@ -28,11 +28,11 @@ struct ccs_sensor; > * @reg_access: Register access quirk. The quirk may divert the access > * to another register, or no register at all. > * > - * @write: Is this read (false) or write (true) access? > - * @reg: Pointer to the register to access > - * @value: Register value, set by the caller on write, or > + * -write: Is this read (false) or write (true) access? > + * -reg: Pointer to the register to access > + * -val: Register value, set by the caller on write, or > * by the quirk on read > - * @return: 0 on success, -ENOIOCTLCMD if no register > + * -return: 0 on success, -ENOIOCTLCMD if no register > * access may be done by the caller (default read > * value is zero), else negative error code on error > * @flags: Quirk flags >
diff --git a/drivers/media/i2c/ccs/ccs-quirk.h b/drivers/media/i2c/ccs/ccs-quirk.h index 0b1a64958d71..392c97109617 100644 --- a/drivers/media/i2c/ccs/ccs-quirk.h +++ b/drivers/media/i2c/ccs/ccs-quirk.h @@ -28,11 +28,11 @@ struct ccs_sensor; * @reg_access: Register access quirk. The quirk may divert the access * to another register, or no register at all. * - * @write: Is this read (false) or write (true) access? - * @reg: Pointer to the register to access - * @value: Register value, set by the caller on write, or + * -write: Is this read (false) or write (true) access? + * -reg: Pointer to the register to access + * -val: Register value, set by the caller on write, or * by the quirk on read - * @return: 0 on success, -ENOIOCTLCMD if no register + * -return: 0 on success, -ENOIOCTLCMD if no register * access may be done by the caller (default read * value is zero), else negative error code on error * @flags: Quirk flags