From: Jonathan Cameron <jic23@kernel.org>
To: Matti Vaittinen <mazziesaccount@gmail.com>
Cc: Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>,
Lars-Peter Clausen <lars@metafoo.de>,
Shreeya Patel <shreeya.patel@collabora.com>,
Paul Gazzillo <paul@pgazz.com>,
Dmitry Osipenko <dmitry.osipenko@collabora.com>,
Zhigang Shi <Zhigang.Shi@liteon.com>,
linux-kernel@vger.kernel.org, linux-iio@vger.kernel.org
Subject: Re: [PATCH v3 2/6] iio: light: Add gain-time-scale helpers
Date: Sat, 18 Mar 2023 17:24:56 +0000 [thread overview]
Message-ID: <20230318172456.4190c9f4@jic23-huawei> (raw)
In-Reply-To: <bad05e06-3b37-b435-bfac-962aef36cc97@gmail.com>
> >>> +/*
> >>
> >> If it's deliberately not a kernel doc, why to bother to have it looking as one?
> >> It's really a provocative to some people who will come with a patches to "fix"
> >> this...
> >
> > Just make it kernel-doc.
> >
>
> Are you sure...? I don't like the idea of polluting generated docs with
> documentation for this type of tiny internal pieces not usable outside
> this component anyways...
You can use :internal or :external to pick up only the docs you want
when including this stuff form a .rst file.
https://docs.kernel.org/doc-guide/kernel-doc.html
>
> >>
> >>> + * iio_gts_get_gain - Convert scale to total gain
> >>> + *
> >>> + * Internal helper for converting scale to total gain.
> >>> + *
> >>> + * @max: Maximum linearized scale. As an example, when scale is created
> >>> + * in magnitude of NANOs and max scale is 64.1 - The linearized
> >>> + * scale is 64 100 000 000.
> >>> + * @scale: Linearized scale to compte the gain for.
> >>> + *
> >>> + * Return: (floored) gain corresponding to the scale. -EINVAL if scale
> >>> + * is invalid.
> >>> + */
> >
> >> ...
> >>
next prev parent reply other threads:[~2023-03-18 17:10 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-06 9:15 [PATCH v3 0/6] Support ROHM BU27034 ALS sensor Matti Vaittinen
2023-03-06 9:15 ` [PATCH v3 1/6] dt-bindings: iio: light: Support ROHM BU27034 Matti Vaittinen
2023-03-06 9:17 ` [PATCH v3 2/6] iio: light: Add gain-time-scale helpers Matti Vaittinen
2023-03-06 12:52 ` Andy Shevchenko
2023-03-12 16:51 ` Jonathan Cameron
2023-03-13 12:56 ` Matti Vaittinen
2023-03-13 13:14 ` Andy Shevchenko
2023-03-14 6:19 ` Vaittinen, Matti
2023-03-14 11:12 ` Andy Shevchenko
2023-03-18 17:17 ` Jonathan Cameron
2023-03-19 14:28 ` Matti Vaittinen
2023-03-18 17:24 ` Jonathan Cameron [this message]
2023-03-13 12:47 ` Matti Vaittinen
2023-03-13 13:25 ` Andy Shevchenko
2023-03-13 13:59 ` Matti Vaittinen
2023-03-13 14:17 ` Andy Shevchenko
2023-03-13 14:25 ` Matti Vaittinen
2023-03-18 17:29 ` Jonathan Cameron
2023-03-12 17:06 ` Jonathan Cameron
2023-03-12 17:08 ` Jonathan Cameron
2023-03-13 12:40 ` Andy Shevchenko
2023-03-13 13:11 ` Matti Vaittinen
2023-03-13 13:29 ` Andy Shevchenko
2023-03-13 13:59 ` Matti Vaittinen
2023-03-15 10:51 ` Matti Vaittinen
2023-03-15 14:12 ` Andy Shevchenko
2023-03-15 14:14 ` Andy Shevchenko
2023-03-17 10:19 ` Maxime Ripard
2023-03-17 10:57 ` Vaittinen, Matti
2023-03-13 12:52 ` Matti Vaittinen
2023-03-06 9:17 ` [PATCH v3 3/6] iio: test: test " Matti Vaittinen
2023-03-06 9:19 ` [PATCH v3 4/6] MAINTAINERS: Add IIO " Matti Vaittinen
2023-03-06 9:23 ` [PATCH v3 5/6] iio: light: ROHM BU27034 Ambient Light Sensor Matti Vaittinen
2023-03-12 17:39 ` Jonathan Cameron
2023-03-13 13:34 ` Matti Vaittinen
2023-03-06 9:27 ` [PATCH v3 6/6] MAINTAINERS: Add ROHM BU27034 Matti Vaittinen
2023-03-06 12:25 ` [PATCH v3 0/6] Support ROHM BU27034 ALS sensor Andy Shevchenko
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=20230318172456.4190c9f4@jic23-huawei \
--to=jic23@kernel.org \
--cc=Zhigang.Shi@liteon.com \
--cc=andriy.shevchenko@linux.intel.com \
--cc=dmitry.osipenko@collabora.com \
--cc=lars@metafoo.de \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=matti.vaittinen@fi.rohmeurope.com \
--cc=mazziesaccount@gmail.com \
--cc=paul@pgazz.com \
--cc=shreeya.patel@collabora.com \
/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