Message ID | 20231223041858.1991349-1-davidgow@google.com |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel+bounces-10283-ouuuleilei=gmail.com@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2483:b0:fb:cd0c:d3e with SMTP id q3csp1482660dyi; Fri, 22 Dec 2023 20:19:23 -0800 (PST) X-Google-Smtp-Source: AGHT+IGq3kyjvR3BAbrAC1AACnPT6C2qp4Nb5qJwP+eX1bgPwl5t+yIA4dBbUUcJePkMD/S5YsJC X-Received: by 2002:a05:620a:ceb:b0:77d:ce42:2d48 with SMTP id c11-20020a05620a0ceb00b0077dce422d48mr2853210qkj.68.1703305163200; Fri, 22 Dec 2023 20:19:23 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1703305163; cv=none; d=google.com; s=arc-20160816; b=wfqTmOzlg2nrzbAYgq2VGPaSKDSvjeSoYgWDXXhUy/C9Y0mSKVD3fZ817vzXtqrPm0 lIROfiiX0PmPstxD0OMyKkNRbADDlhSKfgma6Us9YCJ6L4wc/AothFhVJdZEvXXSrZ00 5SCMgyd52zXc0VbhNiLXqYJiW5Xo3bstNldWwPBKnwrJkiEOV8CHbIzbC5xU0u2Qg21H zSOdMDD84w7ZQ0CR5Wu2IJuzpw5fPOn0NJilpiFD3L1X57CRFaMuIJ5tBWxs7zGEOkKM Jg44gvruljjywwmqbJpPmB378qMdQcFsgK1z9UxDfF8lA6ciao+UoJj7u0AJcmPrqZ3N 2BRw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=cc:to:from:subject:message-id:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:date:dkim-signature; bh=yzOnnfcizg793z1bTTo1OJr4lB84vx2e8wyRTapkvIs=; fh=/jFUGK0tSjug5teaDybh9mmy2rda6hIPuMSeg8tM6bs=; b=hVMrLEl8caE4MEKugTyLtgzf7DU/Z+U727uIM7prhnNJtzwFCyb5RKkYHWg8rxDCm+ azwj7o60/B9DXCleaLqyThClw8rcNWgxpL2o2etM9G4+OfEU6Ts00hEqa0Waw1hSd0AM r1QZpcgbVWQQc7njHDLsYvKFenWrIoNfYdY771UNbfNKi/yZKWffEoRY8DpZF4u8D+ii 63GR8ukWfUMhBoO4kwqcEQQqnC+wqUxc9qrXwko15gFS2pymUgAjINV2et9d80p/bwwR PxYlur6ECUlz5B7+X7No7hubEVH0s4HEDD0UALHdKY58eJ7gI3yWrag7kz+Ngkoevn77 jjTA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=lLE0ntR+; spf=pass (google.com: domain of linux-kernel+bounces-10283-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-10283-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [2604:1380:45d1:ec00::1]) by mx.google.com with ESMTPS id a11-20020a05620a124b00b007811cd43f36si5193526qkl.137.2023.12.22.20.19.23 for <ouuuleilei@gmail.com> (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 22 Dec 2023 20:19:23 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-10283-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=lLE0ntR+; spf=pass (google.com: domain of linux-kernel+bounces-10283-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-10283-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com 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 ny.mirrors.kernel.org (Postfix) with ESMTPS id D6FD31C22A55 for <ouuuleilei@gmail.com>; Sat, 23 Dec 2023 04:19:22 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id E9C564A3C; Sat, 23 Dec 2023 04:19:09 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="lLE0ntR+" X-Original-To: linux-kernel@vger.kernel.org Received: from mail-yw1-f201.google.com (mail-yw1-f201.google.com [209.85.128.201]) (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 2E4521373 for <linux-kernel@vger.kernel.org>; Sat, 23 Dec 2023 04:19:04 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--davidgow.bounces.google.com Received: by mail-yw1-f201.google.com with SMTP id 00721157ae682-5e8d2c6903dso42012867b3.0 for <linux-kernel@vger.kernel.org>; Fri, 22 Dec 2023 20:19:04 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1703305144; x=1703909944; darn=vger.kernel.org; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=yzOnnfcizg793z1bTTo1OJr4lB84vx2e8wyRTapkvIs=; b=lLE0ntR+zEWFdzWCvjjUJmVDp9z8t5fnIdFrV38f2FiThoAvJBLHryywXJXO5+qXac N2uITMudGV9tdb5iVqLmidfUWAs4mMlV8HOW17lXU1YOmimXeyA6K6EiSpIP/pdtXNls feZp0uUeBwsEX8VLe8DYryVLIxVmv4uyZdPLnArjd4yfSXMnjysjAj+bFxaukaDaNQ1X Q9wbMkJjyehQcmwv1zGiH3viASULLZSOWZhPVzTaaMBUMFGTaH6yKtNo5DP3Z+LziY0S /wzqASgCIXrEPu7XoksvdDZsvZqLH/8po5kJptlXZm2K2Y514ppbcXFViBliLIyQIdoG WK/Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1703305144; x=1703909944; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=yzOnnfcizg793z1bTTo1OJr4lB84vx2e8wyRTapkvIs=; b=tMt8CiOAmulq1wQ6AkPS6JerLFh6oofCwT8DwvQdkUs4Wj4unBNRlUrvDKgOwosY2t ff55eDmxlHoA8EPytjzQJhxB457I7lAcTUtdAH4e/BCstBWxTtxGnCGvmYtqPM4oBuCs zs8uoB1TrQVS3inl5FILE7CCr27rGWl4n3pwntvhwd/nQfJgTy9EEx9no2ceZPZ8ldqr rRycLbXKMR6nWR5njqBEK6XuZVOWBf0zh5f3e2JdXV2hCUL7tXk3COF8Q7aJDSx7r0iW NvLhpL9LWL83yMM15Zs95awqtl2yNYWBXMo1qhqgqbZm3PuU6S1OESOnsnbsnsgMN4yb ISmw== X-Gm-Message-State: AOJu0YxAsPlUgV19s4t6PvNlCGyRdPcSzgSF6eNLfZqOSbLoM7Cuxmuw TIuIfLVqDKen0OPakRqRWpoNwJETF/a9IwDnUxa0 X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:20a1]) (user=davidgow job=sendgmr) by 2002:a05:690c:3389:b0:5e8:90de:db6c with SMTP id fl9-20020a05690c338900b005e890dedb6cmr1246726ywb.1.1703305144116; Fri, 22 Dec 2023 20:19:04 -0800 (PST) Date: Sat, 23 Dec 2023 12:18:58 +0800 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: <linux-kernel.vger.kernel.org> List-Subscribe: <mailto:linux-kernel+subscribe@vger.kernel.org> List-Unsubscribe: <mailto:linux-kernel+unsubscribe@vger.kernel.org> Mime-Version: 1.0 X-Mailer: git-send-email 2.43.0.472.g3155946c3a-goog Message-ID: <20231223041858.1991349-1-davidgow@google.com> Subject: [PATCH] kunit: Fix some comments which were mistakenly kerneldoc From: David Gow <davidgow@google.com> To: Shuah Khan <skhan@linuxfoundation.org>, Rae Moar <rmoar@google.com> Cc: kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org, Brendan Higgins <brendan.higgins@linux.dev>, David Gow <davidgow@google.com>, kernel test robot <lkp@intel.com> Content-Type: text/plain; charset="UTF-8" X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1786044914508605498 X-GMAIL-MSGID: 1786044914508605498 |
Series |
kunit: Fix some comments which were mistakenly kerneldoc
|
|
Commit Message
David Gow
Dec. 23, 2023, 4:18 a.m. UTC
The KUnit device helpers are documented with kerneldoc in their header
file, but also have short comments over their implementation. These were
mistakenly formatted as kerneldoc comments, even though they're not
valid kerneldoc. It shouldn't cause any serious problems -- this file
isn't included in the docs -- but it could be confusing, and causes
warnings.
Remove the extra '*' so that these aren't treated as kerneldoc.
Fixes: d03c720e03bd ("kunit: Add APIs for managing devices")
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202312181920.H4EPAH20-lkp@intel.com/
Signed-off-by: David Gow <davidgow@google.com>
---
lib/kunit/device.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
Comments
On 12/22/23 20:18, David Gow wrote: > The KUnit device helpers are documented with kerneldoc in their header > file, but also have short comments over their implementation. These were > mistakenly formatted as kerneldoc comments, even though they're not > valid kerneldoc. It shouldn't cause any serious problems -- this file > isn't included in the docs -- but it could be confusing, and causes > warnings. > > Remove the extra '*' so that these aren't treated as kerneldoc. > > Fixes: d03c720e03bd ("kunit: Add APIs for managing devices") > Reported-by: kernel test robot <lkp@intel.com> > Closes: https://lore.kernel.org/oe-kbuild-all/202312181920.H4EPAH20-lkp@intel.com/ > Signed-off-by: David Gow <davidgow@google.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > lib/kunit/device.c | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > diff --git a/lib/kunit/device.c b/lib/kunit/device.c > index 1db4305b615a..f5371287b375 100644 > --- a/lib/kunit/device.c > +++ b/lib/kunit/device.c > @@ -60,7 +60,7 @@ static void kunit_device_release(struct device *d) > kfree(to_kunit_device(d)); > } > > -/** > +/* > * Create and register a KUnit-managed struct device_driver on the kunit_bus. > * Returns an error pointer on failure. > */ > @@ -124,7 +124,7 @@ static struct kunit_device *kunit_device_register_internal(struct kunit *test, > return kunit_dev; > } > > -/** > +/* > * Create and register a new KUnit-managed device, using the user-supplied device_driver. > * On failure, returns an error pointer. > */ > @@ -141,7 +141,7 @@ struct device *kunit_device_register_with_driver(struct kunit *test, > } > EXPORT_SYMBOL_GPL(kunit_device_register_with_driver); > > -/** > +/* > * Create and register a new KUnit-managed device, including a matching device_driver. > * On failure, returns an error pointer. > */
diff --git a/lib/kunit/device.c b/lib/kunit/device.c index 1db4305b615a..f5371287b375 100644 --- a/lib/kunit/device.c +++ b/lib/kunit/device.c @@ -60,7 +60,7 @@ static void kunit_device_release(struct device *d) kfree(to_kunit_device(d)); } -/** +/* * Create and register a KUnit-managed struct device_driver on the kunit_bus. * Returns an error pointer on failure. */ @@ -124,7 +124,7 @@ static struct kunit_device *kunit_device_register_internal(struct kunit *test, return kunit_dev; } -/** +/* * Create and register a new KUnit-managed device, using the user-supplied device_driver. * On failure, returns an error pointer. */ @@ -141,7 +141,7 @@ struct device *kunit_device_register_with_driver(struct kunit *test, } EXPORT_SYMBOL_GPL(kunit_device_register_with_driver); -/** +/* * Create and register a new KUnit-managed device, including a matching device_driver. * On failure, returns an error pointer. */