From: David Howells <dhowells@redhat.com>
To: Siddh Raman Pant <code@siddh.me>
Cc: dhowells@redhat.com, Mauro Carvalho Chehab <mchehab@kernel.org>,
Randy Dunlap <rdunlap@infradead.org>,
Jonathan Corbet <corbet@lwn.net>,
"Fabio M. De Francesco" <fmdefrancesco@gmail.com>,
Eric Dumazet <edumazet@google.com>,
Christophe JAILLET <christophe.jaillet@wanadoo.fr>,
Eric Biggers <ebiggers@kernel.org>,
keyrings <keyrings@vger.kernel.org>,
linux-security-module <linux-security-module@vger.kernel.org>,
linux-fsdevel <linux-fsdevel@vger.kernel.org>,
linux-kernel <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH v3 1/2] include/linux/watch_queue: Improve documentation
Date: Tue, 10 Jan 2023 14:09:32 +0000 [thread overview]
Message-ID: <2121105.1673359772@warthog.procyon.org.uk> (raw)
In-Reply-To: <97ce37e2fdcfbed29d9467057f0f870359d88b89.1673173920.git.code@siddh.me>
Siddh Raman Pant <code@siddh.me> wrote:
> +/**
> + * struct watch_type_filter - Filter on watch type
> + *
> + * @type: Type of watch_notification
> + * @subtype_filter: Bitmask of subtypes to filter on
> + * @info_filter: Filter on watch_notification::info
> + * @info_mask: Mask of relevant bits in info_filter
> + */
> struct watch_type_filter {
> enum watch_notification_type type;
> - __u32 subtype_filter[1]; /* Bitmask of subtypes to filter on */
> - __u32 info_filter; /* Filter on watch_notification::info */
> - __u32 info_mask; /* Mask of relevant bits in info_filter */
> + __u32 subtype_filter[1];
> + __u32 info_filter;
> + __u32 info_mask;
> };
Please don't.
The structure is documented fully here:
Documentation/core-api/watch_queue.rst
See:
https://docs.kernel.org/core-api/watch_queue.html#event-filtering
The three column approach is much more readable in the code as it doesn't
separate the descriptions from the things described. Putting things in
columns has been around for around 6000 years.
David
next prev parent reply other threads:[~2023-01-10 14:11 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-08 10:36 [PATCH v3 0/2] watch_queue: Clean up some code Siddh Raman Pant
2023-01-08 10:36 ` [PATCH v3 1/2] include/linux/watch_queue: Improve documentation Siddh Raman Pant
2023-01-10 14:09 ` David Howells [this message]
2023-01-10 19:10 ` Siddh Raman Pant
2023-01-11 15:48 ` David Howells
2023-01-11 15:50 ` Siddh Raman Pant
2023-01-08 10:36 ` [PATCH v3 2/2] kernel/watch_queue: NULL the dangling *pipe, and use it for clear check Siddh Raman Pant
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=2121105.1673359772@warthog.procyon.org.uk \
--to=dhowells@redhat.com \
--cc=christophe.jaillet@wanadoo.fr \
--cc=code@siddh.me \
--cc=corbet@lwn.net \
--cc=ebiggers@kernel.org \
--cc=edumazet@google.com \
--cc=fmdefrancesco@gmail.com \
--cc=keyrings@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-security-module@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