Received-SPF: pass (google.com: domain of linux-kernel+bounces-10284-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
Message-ID: <29ef2f6b-f184-4913-a47d-32b175a2bd6a@infradead.org>
Date: Fri, 22 Dec 2023 20:23:24 -0800
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH] kunit: Fix some comments which were mistakenly kerneldoc
Content-Language: en-US
To: David Gow <davidgow@google.com>, 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>,
 kernel test robot <lkp@intel.com>
References: <20231223041858.1991349-1-davidgow@google.com>
From: Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <20231223041858.1991349-1-davidgow@google.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit


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

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html