From: Siddh Raman Pant via Linux-kernel-mentees <linux-kernel-mentees@lists.linuxfoundation.org>
To: "Eric Biggers" <ebiggers@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Randy Dunlap <rdunlap@infradead.org>,
linux-kernel <linux-kernel@vger.kernel.org>,
David Howells <dhowells@redhat.com>,
Eric Dumazet <edumazet@google.com>,
Christophe JAILLET <christophe.jaillet@wanadoo.fr>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
linux-kernel-mentees
<linux-kernel-mentees@lists.linuxfoundation.org>
Subject: Re: [PATCH 2/3] kernel/watch_queue: Improve struct annotation formatting
Date: Fri, 05 Aug 2022 15:05:32 +0530 [thread overview]
Message-ID: <1826d5c2956.568f80f5118689.2103252186884814555@siddh.me> (raw)
In-Reply-To: <YuzFIx36zDXX0z/0@sol.localdomain>
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
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
next prev parent reply other threads:[~2022-08-05 9:35 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-04 13:30 [PATCH 0/3] kernel/watch_queue: Clean up some code Siddh Raman Pant via Linux-kernel-mentees
2022-08-04 13:30 ` [PATCH 1/3 v4] kernel/watch_queue: Remove dangling pipe reference while clearing watch_queue Siddh Raman Pant via Linux-kernel-mentees
2022-08-04 13:30 ` [PATCH 2/3] kernel/watch_queue: Improve struct annotation formatting Siddh Raman Pant via Linux-kernel-mentees
2022-08-05 7:22 ` Eric Biggers
2022-08-05 9:35 ` Siddh Raman Pant via Linux-kernel-mentees [this message]
2022-08-04 13:30 ` [PATCH 3/3] kernel/watch_queue: Remove wqueue->defunct and use pipe for clear check Siddh Raman Pant via Linux-kernel-mentees
2022-08-04 14:41 ` [PATCH v2 " Siddh Raman Pant via Linux-kernel-mentees
2022-08-05 7:24 ` Eric Biggers
2022-08-05 9:35 ` Siddh Raman Pant via Linux-kernel-mentees
2022-08-05 18:33 ` Eric Biggers
2022-08-06 7:23 ` Siddh Raman Pant via Linux-kernel-mentees
2022-08-05 7:16 ` [PATCH 0/3] kernel/watch_queue: Clean up some code Eric Biggers
2022-08-05 9:35 ` Siddh Raman Pant via Linux-kernel-mentees
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1826d5c2956.568f80f5118689.2103252186884814555@siddh.me \
--to=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=christophe.jaillet@wanadoo.fr \
--cc=code@siddh.me \
--cc=corbet@lwn.net \
--cc=dhowells@redhat.com \
--cc=ebiggers@kernel.org \
--cc=edumazet@google.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@kernel.org \
--cc=rdunlap@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).