Messages in this thread | | | Date | Fri, 05 Aug 2022 15:05:32 +0530 | From | Siddh Raman Pant <> | Subject | Re: [PATCH 2/3] kernel/watch_queue: Improve struct annotation formatting |
| |
On Fri, 05 Aug 2022 12:52:11 +0530 Eric Biggers wrote: > On Thu, Aug 04, 2022 at 07:00:23PM +0530, Siddh Raman Pant wrote: > > Improve formatting struct annotations in watch_queue.h, so that they > > fall in the preferred 80 character limit. > > > > Signed-off-by: Siddh Raman Pant code@siddh.me> > > This patch isn't just fixing overly long lines, but rather is introducing > kerneldoc comments and documenting things that weren't documented before. > That's fine, but please make the commit message accurately describe the patch. > > > diff --git a/include/linux/watch_queue.h b/include/linux/watch_queue.h > > index fc6bba20273b..c99c39ec6548 100644 > > --- a/include/linux/watch_queue.h > > +++ b/include/linux/watch_queue.h > > @@ -18,57 +18,103 @@ > > > > struct cred; > > > > +/** > > + * watch_type_filter - Filter on watch type > > If you're going to use kerneldoc comments, they should be correctly formatted. > This is not, since it's missing the word struct. You can run this command to > see the kerneldoc warnings: > > ./scripts/kernel-doc -v -none include/linux/watch_queue.h > > > + * @lock: Spinlock > > Please make sure that comments provide useful information and don't just repeat > what the code says. > > - Eric >
Okay, will do.
Thanks, Siddh
| |