From: Mehdi Djait <mehdi.djait.k@gmail.com>
To: jic23@kernel.org, lars@metafoo.de
Cc: andriy.shevchenko@linux.intel.com, linux-iio@vger.kernel.org,
linux-kernel@vger.kernel.org,
Mehdi Djait <mehdi.djait.k@gmail.com>
Subject: [PATCH 0/2] iio: Add kernel-doc and rename
Date: Mon, 27 Feb 2023 19:00:37 +0100 [thread overview]
Message-ID: <cover.1677520155.git.mehdi.djait.k@gmail.com> (raw)
The main goal behind the kernel-docs is to give a hint where the
functions are expected to be called.
Renaming iio_trigger_poll_chained() to iio_trigger_poll_nested() came
from a Jonathan's suggestion in [1]
I am a little bit unsure about moving the kernel-doc of iio_trigger_poll
to industrialio-trigger.c
My motivation behind it:
- having the source code together with the documentation tends to be
better for understanding
- make it easier to understand the _nested in iio_trigger_poll_nested
(the call to handle_nested_irq)
[1] https://lore.kernel.org/linux-iio/Y+6QoBLh1k82cJVN@carbian/
--
Kind Regards
Mehdi Djait
Mehdi Djait (2):
iio: Improve the kernel-doc of iio_trigger_poll
iio: Rename iio_trigger_poll_chained and add kernel-doc
drivers/iio/accel/bma400_core.c | 2 +-
drivers/iio/accel/kionix-kx022a.c | 2 +-
drivers/iio/accel/mma8452.c | 2 +-
drivers/iio/accel/msa311.c | 2 +-
drivers/iio/adc/ad7606.c | 2 +-
drivers/iio/adc/at91-sama5d2_adc.c | 2 +-
drivers/iio/adc/max11410.c | 2 +-
.../common/st_sensors/st_sensors_trigger.c | 4 ++--
drivers/iio/gyro/fxas21002c_core.c | 2 +-
drivers/iio/gyro/mpu3050-core.c | 2 +-
drivers/iio/humidity/hts221_buffer.c | 2 +-
drivers/iio/industrialio-trigger.c | 19 +++++++++++++++++--
drivers/iio/light/acpi-als.c | 2 +-
drivers/iio/light/rpr0521.c | 2 +-
drivers/iio/light/st_uvis25_core.c | 2 +-
drivers/iio/light/vcnl4000.c | 2 +-
drivers/iio/light/vcnl4035.c | 2 +-
drivers/iio/potentiostat/lmp91000.c | 2 +-
drivers/iio/pressure/zpa2326.c | 2 +-
drivers/iio/proximity/as3935.c | 2 +-
drivers/iio/trigger/iio-trig-loop.c | 2 +-
include/linux/iio/trigger.h | 8 +-------
22 files changed, 39 insertions(+), 30 deletions(-)
--
2.30.2
next reply other threads:[~2023-02-27 18:03 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-27 18:00 Mehdi Djait [this message]
2023-02-27 18:00 ` [PATCH 1/2] iio: Improve the kernel-doc of iio_trigger_poll Mehdi Djait
2023-02-27 22:50 ` Andy Shevchenko
2023-02-28 19:16 ` Mehdi Djait
2023-02-27 18:00 ` [PATCH 2/2] iio: Rename iio_trigger_poll_chained and add kernel-doc Mehdi Djait
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=cover.1677520155.git.mehdi.djait.k@gmail.com \
--to=mehdi.djait.k@gmail.com \
--cc=andriy.shevchenko@linux.intel.com \
--cc=jic23@kernel.org \
--cc=lars@metafoo.de \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.