mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] bcache: fix kernel-doc warning on CLOSURE_CALLBACK
@ 2026-10-04 23:35 Rosen Penev
  2026-10-09  3:41 ` Coly Li
  0 siblings, 1 reply; 4+ messages in thread
From: Rosen Penev @ 2026-10-04 23:35 UTC (permalink / raw)
  To: linux-bcache; +Cc: Coly Li, Kent Overstreet, open list

bch_data_insert() is defined through the CLOSURE_CALLBACK() macro, which
kernel-doc cannot see through, so the kernel-doc comment above it
produces:

  request.c:308 function parameter 'bch_data_insert' not described in 'CLOSURE_CALLBACK'
  request.c:308 expecting prototype for bch_data_insert(). Prototype was for CLOSURE_CALLBACK() instead

Turn it into a regular block comment, and drop the @cl line along
with the kernel-doc markup.

Assisted-by: LLM
Signed-off-by: Rosen Penev <rosenp@gmail.com>
---
 drivers/md/bcache/request.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/drivers/md/bcache/request.c b/drivers/md/bcache/request.c
index 3fa3b13a410f..e7f097346d64 100644
--- a/drivers/md/bcache/request.c
+++ b/drivers/md/bcache/request.c
@@ -285,9 +285,8 @@ static CLOSURE_CALLBACK(bch_data_insert_start)
 	}
 }
 
-/**
+/*
  * bch_data_insert - stick some data in the cache
- * @cl: closure pointer.
  *
  * This is the starting point for any data to end up in a cache device; it could
  * be from a normal write, or a writeback write, or a write to a flash only
-- 
2.56.0


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] bcache: fix kernel-doc warning on CLOSURE_CALLBACK
  2026-10-04 23:35 [PATCH] bcache: fix kernel-doc warning on CLOSURE_CALLBACK Rosen Penev
@ 2026-10-09  3:41 ` Coly Li
  2026-10-09  4:09   ` Rosen Penev
  0 siblings, 1 reply; 4+ messages in thread
From: Coly Li @ 2026-10-09  3:41 UTC (permalink / raw)
  To: Rosen Penev; +Cc: linux-bcache, Kent Overstreet, open list

Hi Rosen,

On Sun, Oct 04, 2026 at 04:35:23PM +0800, Rosen Penev wrote:
> bch_data_insert() is defined through the CLOSURE_CALLBACK() macro, which
> kernel-doc cannot see through, so the kernel-doc comment above it
> produces:
> 
>   request.c:308 function parameter 'bch_data_insert' not described in 'CLOSURE_CALLBACK'
>   request.c:308 expecting prototype for bch_data_insert(). Prototype was for CLOSURE_CALLBACK() instead
> 
> Turn it into a regular block comment, and drop the @cl line along
> with the kernel-doc markup.
> 
> Assisted-by: LLM

The patch is fine to me. Can you provide the detailed LLM name here?

> Signed-off-by: Rosen Penev <rosenp@gmail.com>

Thanks.

Coly Li

> ---
>  drivers/md/bcache/request.c | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/drivers/md/bcache/request.c b/drivers/md/bcache/request.c
> index 3fa3b13a410f..e7f097346d64 100644
> --- a/drivers/md/bcache/request.c
> +++ b/drivers/md/bcache/request.c
> @@ -285,9 +285,8 @@ static CLOSURE_CALLBACK(bch_data_insert_start)
>  	}
>  }
>  
> -/**
> +/*
>   * bch_data_insert - stick some data in the cache
> - * @cl: closure pointer.
>   *
>   * This is the starting point for any data to end up in a cache device; it could
>   * be from a normal write, or a writeback write, or a write to a flash only
> -- 
> 2.56.0

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] bcache: fix kernel-doc warning on CLOSURE_CALLBACK
  2026-10-09  3:41 ` Coly Li
@ 2026-10-09  4:09   ` Rosen Penev
  2026-10-09  4:54     ` Coly Li
  0 siblings, 1 reply; 4+ messages in thread
From: Rosen Penev @ 2026-10-09  4:09 UTC (permalink / raw)
  To: Coly Li; +Cc: linux-bcache, Kent Overstreet, open list

On Thu, Oct 8, 2026 at 8:41 PM Coly Li <colyli@fygo.io> wrote:
>
> Hi Rosen,
>
> On Sun, Oct 04, 2026 at 04:35:23PM +0800, Rosen Penev wrote:
> > bch_data_insert() is defined through the CLOSURE_CALLBACK() macro, which
> > kernel-doc cannot see through, so the kernel-doc comment above it
> > produces:
> >
> >   request.c:308 function parameter 'bch_data_insert' not described in 'CLOSURE_CALLBACK'
> >   request.c:308 expecting prototype for bch_data_insert(). Prototype was for CLOSURE_CALLBACK() instead
> >
> > Turn it into a regular block comment, and drop the @cl line along
> > with the kernel-doc markup.
> >
> > Assisted-by: LLM
>
> The patch is fine to me. Can you provide the detailed LLM name here?
It was Opencode's Big Pickle IIRC. Current documentation says to just say LLM.
>
> > Signed-off-by: Rosen Penev <rosenp@gmail.com>
>
> Thanks.
>
> Coly Li
>
> > ---
> >  drivers/md/bcache/request.c | 3 +--
> >  1 file changed, 1 insertion(+), 2 deletions(-)
> >
> > diff --git a/drivers/md/bcache/request.c b/drivers/md/bcache/request.c
> > index 3fa3b13a410f..e7f097346d64 100644
> > --- a/drivers/md/bcache/request.c
> > +++ b/drivers/md/bcache/request.c
> > @@ -285,9 +285,8 @@ static CLOSURE_CALLBACK(bch_data_insert_start)
> >       }
> >  }
> >
> > -/**
> > +/*
> >   * bch_data_insert - stick some data in the cache
> > - * @cl: closure pointer.
> >   *
> >   * This is the starting point for any data to end up in a cache device; it could
> >   * be from a normal write, or a writeback write, or a write to a flash only
> > --
> > 2.56.0

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] bcache: fix kernel-doc warning on CLOSURE_CALLBACK
  2026-10-09  4:09   ` Rosen Penev
@ 2026-10-09  4:54     ` Coly Li
  0 siblings, 0 replies; 4+ messages in thread
From: Coly Li @ 2026-10-09  4:54 UTC (permalink / raw)
  To: Rosen Penev; +Cc: linux-bcache, Kent Overstreet, open list

> 2026年10月9日 12:09,Rosen Penev <rosenp@gmail.com> 写道:
> 
> On Thu, Oct 8, 2026 at 8:41 PM Coly Li <colyli@fygo.io> wrote:
>> 
>> Hi Rosen,
>> 
>> On Sun, Oct 04, 2026 at 04:35:23PM +0800, Rosen Penev wrote:
>>> bch_data_insert() is defined through the CLOSURE_CALLBACK() macro, which
>>> kernel-doc cannot see through, so the kernel-doc comment above it
>>> produces:
>>> 
>>>  request.c:308 function parameter 'bch_data_insert' not described in 'CLOSURE_CALLBACK'
>>>  request.c:308 expecting prototype for bch_data_insert(). Prototype was for CLOSURE_CALLBACK() instead
>>> 
>>> Turn it into a regular block comment, and drop the @cl line along
>>> with the kernel-doc markup.
>>> 
>>> Assisted-by: LLM
>> 
>> The patch is fine to me. Can you provide the detailed LLM name here?
> It was Opencode's Big Pickle IIRC. Current documentation says to just say LLM.

Documentation file coding-assistants.rst suggests,

 43 Attribution
 44 ===========
 45
 46 When AI tools contribute to kernel development, proper attribution
 47 helps track the evolving role of AI in the development process.
 48 Contributions should include an Assisted-by tag in the following format::
 49
 50   Assisted-by: LLM [TOOL1] [TOOL2]
 51
 52 * ``[TOOL1] [TOOL2]`` are optional specialized analysis tools used
 53   (e.g., coccinelle, sparse, smatch, clang-tidy)
 54
 55 Basic development tools (git, gcc, make, editors) should not be listed.
 56
 57 Example::
 58
 59   Assisted-by: LLM coccinelle sparse

Yes,  only listing LLM is the bottom line, and list the detailed model name is better.

If you don’t want to post v2 patch, you can give me a line of Assisted-by: , I can replace it in the patch.

Thanks.

Coly Li


>> 
>>> Signed-off-by: Rosen Penev <rosenp@gmail.com>
>> 
>> Thanks.
>> 
>> Coly Li
>> 
>>> ---
>>> drivers/md/bcache/request.c | 3 +--
>>> 1 file changed, 1 insertion(+), 2 deletions(-)
>>> 
>>> diff --git a/drivers/md/bcache/request.c b/drivers/md/bcache/request.c
>>> index 3fa3b13a410f..e7f097346d64 100644
>>> --- a/drivers/md/bcache/request.c
>>> +++ b/drivers/md/bcache/request.c
>>> @@ -285,9 +285,8 @@ static CLOSURE_CALLBACK(bch_data_insert_start)
>>>      }
>>> }
>>> 
>>> -/**
>>> +/*
>>>  * bch_data_insert - stick some data in the cache
>>> - * @cl: closure pointer.
>>>  *
>>>  * This is the starting point for any data to end up in a cache device; it could
>>>  * be from a normal write, or a writeback write, or a write to a flash only
>>> --
>>> 2.56.0

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2026-10-09  4:54 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-10-04 23:35 [PATCH] bcache: fix kernel-doc warning on CLOSURE_CALLBACK Rosen Penev
2026-10-09  3:41 ` Coly Li
2026-10-09  4:09   ` Rosen Penev
2026-10-09  4:54     ` Coly Li

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®